Required permission: | CreatePayables |
POST | /Finance/CreatePayable/{vendor_id} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
vendor_id | path | string | No | |
total_amount | body | decimal | No | |
tax_amount | body | decimal? | No | |
tax_schedule | body | string | No | |
tax_account | body | string | No | |
description | body | string | No | |
batch_id | body | string | No | |
is_eft | body | bool | No | |
invoice_id | body | string | No | |
chequebook | body | string | No | |
document_date | body | DateTime | No | |
post_date | body | DateTime | No | |
distributions | body | List<FinanceCreatePayableDistributionRequest> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
account | form | string | No | |
amount | form | decimal | No | |
description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
cheque_id | form | string | No | |
invoice_id | form | string | No | |
batch_id | form | string | No | |
transaction_batch_id | form | string | No | |
total_amount | form | decimal | No | |
unapplied_amount | form | decimal | No | |
description | form | string | No | |
vendor_id | form | string | No | |
vendor_name | form | string | No | |
doc_type | form | string | No | |
is_posted | form | bool | No | |
is_paid | form | bool | No | |
is_voided | form | bool | No | |
is_reimbursed | form | bool | No | |
doc_date | form | DateTime? | No | |
post_date | form | DateTime? | No | |
cheque_date | form | DateTime? | No | |
due_date | form | DateTime? | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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-01,
post_date: 0001-01-01,
distributions:
[
{
account: String,
amount: 0,
description: 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 } } }