regis

<back to all web services

FinanceCreatePayableRequest

Requires Authentication
Required permission:CreatePayables
The following routes are available for this service:
POST/Finance/CreatePayable/{vendor_id}
"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 FinanceCreatePayableDistributionRequest {
    /** @param {{account?:string,amount?:number,description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    account;
    /** @type {number} */
    amount;
    /** @type {string} */
    description;
}
export class FinanceCreatePayableRequest {
    /** @param {{vendor_id?:string,total_amount?:number,tax_amount?:number,tax_schedule?:string,tax_account?:string,description?:string,batch_id?:string,is_eft?:boolean,invoice_id?:string,chequebook?:string,document_date?:string,post_date?:string,distributions?:FinanceCreatePayableDistributionRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    vendor_id;
    /** @type {number} */
    total_amount;
    /** @type {?number} */
    tax_amount;
    /** @type {string} */
    tax_schedule;
    /** @type {string} */
    tax_account;
    /** @type {string} */
    description;
    /** @type {string} */
    batch_id;
    /** @type {boolean} */
    is_eft;
    /** @type {string} */
    invoice_id;
    /** @type {string} */
    chequebook;
    /** @type {string} */
    document_date;
    /** @type {string} */
    post_date;
    /** @type {FinanceCreatePayableDistributionRequest[]} */
    distributions;
}

JavaScript FinanceCreatePayableRequest DTOs

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

HTTP + CSV

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

POST /Finance/CreatePayable/{vendor_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"vendor_id":"String","total_amount":0,"tax_amount":0,"tax_schedule":"String","tax_account":"String","description":"String","batch_id":"String","is_eft":false,"invoice_id":"String","chequebook":"String","document_date":"0001-01-01T00:00:00.0000000","post_date":"0001-01-01T00:00:00.0000000","distributions":[{"account":"String","amount":0,"description":"String"}]}

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","post_date":"0001-01-01T00:00:00.0000000","cheque_date":"0001-01-01T00:00:00.0000000","due_date":"0001-01-01T00:00:00.0000000","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}