regis

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FinanceCreatePayableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <batch_id>String</batch_id>
  <chequebook>String</chequebook>
  <description>String</description>
  <distributions>
    <FinanceCreatePayableDistributionRequest>
      <account>String</account>
      <amount>0</amount>
      <description>String</description>
    </FinanceCreatePayableDistributionRequest>
  </distributions>
  <document_date>0001-01-01T00:00:00</document_date>
  <invoice_id>String</invoice_id>
  <is_eft>false</is_eft>
  <post_date>0001-01-01T00:00:00</post_date>
  <tax_account>String</tax_account>
  <tax_amount>0</tax_amount>
  <tax_schedule>String</tax_schedule>
  <total_amount>0</total_amount>
  <vendor_id>String</vendor_id>
</FinanceCreatePayableRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancePayableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <batch_id>String</batch_id>
  <cheque_date>0001-01-01T00:00:00</cheque_date>
  <cheque_id>String</cheque_id>
  <description>String</description>
  <doc_date>0001-01-01T00:00:00</doc_date>
  <doc_type>String</doc_type>
  <due_date>0001-01-01T00:00:00</due_date>
  <invoice_id>String</invoice_id>
  <is_paid>false</is_paid>
  <is_posted>false</is_posted>
  <is_reimbursed>false</is_reimbursed>
  <is_voided>false</is_voided>
  <post_date>0001-01-01T00:00:00</post_date>
  <total_amount>0</total_amount>
  <transaction_batch_id>String</transaction_batch_id>
  <unapplied_amount>0</unapplied_amount>
  <vendor_id>String</vendor_id>
  <vendor_name>String</vendor_name>
</FinancePayableResponse>