regis

<back to all web services

FinancePayableRequest

Requires Authentication
Required permission:CreatePayables
The following routes are available for this service:
POST/Finance/Payable
"use strict";
export class FinancePayableResponse {
    /** @param {{cheque_id?:string,invoice_id?:string,batch_id?:string,transaction_batch_id?:string,total_amount?:number,unapplied_amount?:number,description?:string,vendor_id?:string,vendor_name?:string,doc_type?:string,is_posted?:boolean,is_paid?:boolean,is_voided?:boolean,is_reimbursed?:boolean,doc_date?:string,post_date?:string,cheque_date?:string,due_date?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    cheque_id;
    /** @type {string} */
    invoice_id;
    /** @type {string} */
    batch_id;
    /** @type {string} */
    transaction_batch_id;
    /** @type {number} */
    total_amount;
    /** @type {number} */
    unapplied_amount;
    /** @type {string} */
    description;
    /** @type {string} */
    vendor_id;
    /** @type {string} */
    vendor_name;
    /** @type {string} */
    doc_type;
    /** @type {boolean} */
    is_posted;
    /** @type {boolean} */
    is_paid;
    /** @type {boolean} */
    is_voided;
    /** @type {boolean} */
    is_reimbursed;
    /** @type {?string} */
    doc_date;
    /** @type {?string} */
    post_date;
    /** @type {?string} */
    cheque_date;
    /** @type {?string} */
    due_date;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class FinancePayableRequest {
    /** @param {{cheque_id?:string,invoice_id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    cheque_id;
    /** @type {string} */
    invoice_id;
}

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

{
	cheque_id: String,
	invoice_id: String
}
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
		}
	}
}