regis

<back to all web services

InvoiceDynamicsAuditRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/finance/invoice-dynamics-audit
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class InvoiceDynamicsAuditRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var DateTime */
        public DateTime $from_date=new DateTime(),
        /** @var DateTime */
        public DateTime $to_date=new DateTime(),
        /** @var int|null */
        public ?int $regent_id=null,
        /** @var string|null */
        public ?string $invoice_status=null,
        /** @var string|null */
        public ?string $dynamics_status=null,
        /** @var bool|null */
        public ?bool $include_logs=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['from_date'])) $this->from_date = JsonConverters::from('DateTime', $o['from_date']);
        if (isset($o['to_date'])) $this->to_date = JsonConverters::from('DateTime', $o['to_date']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['invoice_status'])) $this->invoice_status = $o['invoice_status'];
        if (isset($o['dynamics_status'])) $this->dynamics_status = $o['dynamics_status'];
        if (isset($o['include_logs'])) $this->include_logs = $o['include_logs'];
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->from_date)) $o['from_date'] = JsonConverters::to('DateTime', $this->from_date);
        if (isset($this->to_date)) $o['to_date'] = JsonConverters::to('DateTime', $this->to_date);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->invoice_status)) $o['invoice_status'] = $this->invoice_status;
        if (isset($this->dynamics_status)) $o['dynamics_status'] = $this->dynamics_status;
        if (isset($this->include_logs)) $o['include_logs'] = $this->include_logs;
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP InvoiceDynamicsAuditRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /finance/invoice-dynamics-audit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InvoiceDynamicsAuditRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <dynamics_status>String</dynamics_status>
  <from_date>0001-01-01T00:00:00</from_date>
  <include_logs>false</include_logs>
  <invoice_status>String</invoice_status>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <to_date>0001-01-01T00:00:00</to_date>
</InvoiceDynamicsAuditRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfInvoiceDynamicsAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <InvoiceDynamicsAuditResponse>
    <description>String</description>
    <dynamics_status>String</dynamics_status>
    <dynamics_transactions>
      <InvoiceDynamicsTransactionResponse>
        <action>String</action>
        <batch_number>String</batch_number>
        <customer_number>String</customer_number>
        <document_date>0001-01-01T00:00:00</document_date>
        <document_number>String</document_number>
        <dynamics_log_id>0</dynamics_log_id>
        <found_in_gp>false</found_in_gp>
        <gp_amount>0</gp_amount>
        <gp_source>String</gp_source>
        <gp_status>0</gp_status>
        <gp_type>0</gp_type>
        <is_open>false</is_open>
        <is_posted>false</is_posted>
        <is_void>false</is_void>
        <logged_amount>0</logged_amount>
        <logged_at>0001-01-01T00:00:00</logged_at>
        <note>String</note>
        <posting_date>0001-01-01T00:00:00</posting_date>
        <regis_invoice_reference>String</regis_invoice_reference>
      </InvoiceDynamicsTransactionResponse>
    </dynamics_transactions>
    <econnect_logs>
      <InvoiceEconnectLogResponse>
        <id>0</id>
        <response>String</response>
        <timestamp>0001-01-01T00:00:00</timestamp>
        <xml>String</xml>
      </InvoiceEconnectLogResponse>
    </econnect_logs>
    <has_regis_invoice>false</has_regis_invoice>
    <initiator_name>String</initiator_name>
    <invoice_date>0001-01-01T00:00:00</invoice_date>
    <invoice_id>0</invoice_id>
    <invoice_status>String</invoice_status>
    <invoice_uuid>String</invoice_uuid>
    <reconciliation_type>String</reconciliation_type>
    <regent_id>0</regent_id>
    <reporting_term>String</reporting_term>
    <student_name>String</student_name>
    <student_uuid>String</student_uuid>
    <total_charges>0</total_charges>
    <total_credits>0</total_credits>
  </InvoiceDynamicsAuditResponse>
</ArrayOfInvoiceDynamicsAuditResponse>