regis

<back to all web services

FinancePayablesRequest

Requires Authentication
Required permission:CreatePayables
The following routes are available for this service:
POST/Finance/Payables
<?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 FinancePayablesRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $cheque_date=new DateTime()
    ) {
    }

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

PHP FinancePayablesRequest 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/Payables HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	cheque_date: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		cheque_id: String,
		invoice_id: String,
		batch_id: String,
		transaction_batch_id: String,
		total_amount: 0,
		unapplied_amount: 0,
		description: String,
		vendor_id: String,
		vendor_name: String,
		doc_type: String,
		is_posted: False,
		is_paid: False,
		is_voided: False,
		is_reimbursed: False,
		doc_date: 0001-01-01,
		post_date: 0001-01-01,
		cheque_date: 0001-01-01,
		due_date: 0001-01-01,
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	}
]