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}

export class FinancePayableResponse
{
    public cheque_id: string;
    public invoice_id: string;
    public batch_id: string;
    public transaction_batch_id: string;
    public total_amount: number;
    public unapplied_amount: number;
    public description: string;
    public vendor_id: string;
    public vendor_name: string;
    public doc_type: string;
    public is_posted: boolean;
    public is_paid: boolean;
    public is_voided: boolean;
    public is_reimbursed: boolean;
    public doc_date?: string;
    public post_date?: string;
    public cheque_date?: string;
    public due_date?: string;
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<FinancePayableResponse>) { (Object as any).assign(this, init); }
}

export class FinanceCreatePayableDistributionRequest
{
    public account: string;
    public amount: number;
    public description: string;

    public constructor(init?: Partial<FinanceCreatePayableDistributionRequest>) { (Object as any).assign(this, init); }
}

export class FinanceCreatePayableRequest
{
    public vendor_id: string;
    public total_amount: number;
    public tax_amount?: number;
    public tax_schedule: string;
    public tax_account: string;
    public description: string;
    public batch_id: string;
    public is_eft: boolean;
    public invoice_id: string;
    public chequebook: string;
    public document_date: string;
    public post_date: string;
    public distributions: FinanceCreatePayableDistributionRequest[];

    public constructor(init?: Partial<FinanceCreatePayableRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}