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}
FinanceCreatePayableRequest Parameters:
NameParameterData TypeRequiredDescription
vendor_idpathstringNo
total_amountbodydecimalNo
tax_amountbodydecimal?No
tax_schedulebodystringNo
tax_accountbodystringNo
descriptionbodystringNo
batch_idbodystringNo
is_eftbodyboolNo
invoice_idbodystringNo
chequebookbodystringNo
document_datebodyDateTimeNo
post_datebodyDateTimeNo
distributionsbodyList<FinanceCreatePayableDistributionRequest>No
FinanceCreatePayableDistributionRequest Parameters:
NameParameterData TypeRequiredDescription
accountformstringNo
amountformdecimalNo
descriptionformstringNo
FinancePayableResponse Parameters:
NameParameterData TypeRequiredDescription
cheque_idformstringNo
invoice_idformstringNo
batch_idformstringNo
transaction_batch_idformstringNo
total_amountformdecimalNo
unapplied_amountformdecimalNo
descriptionformstringNo
vendor_idformstringNo
vendor_nameformstringNo
doc_typeformstringNo
is_postedformboolNo
is_paidformboolNo
is_voidedformboolNo
is_reimbursedformboolNo
doc_dateformDateTime?No
post_dateformDateTime?No
cheque_dateformDateTime?No
due_dateformDateTime?No
ResponseStatusformResponseStatusNo

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/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
		}
	}
}