regis

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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	from_date: 0001-01-01,
	to_date: 0001-01-01,
	regent_id: 0,
	invoice_status: String,
	dynamics_status: String,
	include_logs: False,
	authorizing_uuid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		invoice_id: 0,
		invoice_uuid: String,
		reporting_term: String,
		invoice_date: 0001-01-01,
		invoice_status: String,
		description: String,
		total_charges: 0,
		total_credits: 0,
		net: 0,
		regent_id: 0,
		student_uuid: String,
		student_name: String,
		initiator_name: String,
		has_regis_invoice: False,
		reconciliation_type: String,
		dynamics_status: String,
		dynamics_transactions: 
		[
			{
				dynamics_log_id: 0,
				action: String,
				note: String,
				logged_amount: 0,
				document_number: String,
				customer_number: String,
				logged_at: 0001-01-01,
				regis_invoice_reference: String,
				gp_source: String,
				found_in_gp: False,
				gp_type: 0,
				gp_status: 0,
				batch_number: String,
				gp_amount: 0,
				is_open: False,
				is_posted: False,
				is_void: False,
				document_date: 0001-01-01,
				posting_date: 0001-01-01
			}
		],
		econnect_logs: 
		[
			{
				id: 0,
				timestamp: 0001-01-01,
				xml: String,
				response: String
			}
		]
	}
]