Billiecart API

CreatePaymentRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
POST	/payments

**CreatePaymentRequest** Parameters:
Name	Parameter	Data Type	Required
SalaryPackageId	body	string	No
Amount	body	decimal	No
GstAmount	body	decimal	No
Particulars	body	string	No
BudgetCategory	body	string	No

**PostOperationTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
OrganisationId	form	string	No

**CreatePaymentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Payment	form	Payment	No

**Payment** Parameters:
Name	Parameter	Data Type	Required
SalaryPackageId	form	string	No
Amount	form	decimal	No
GstAmount	form	decimal	No
Particulars	form	string	No
BudgetCategory	form	string	No
Status	form	string	No
ToAccount	form	BankAccount	No
Id	form	string	No

**BankAccount** Parameters:
Name	Parameter	Data Type	Required	Description
BsbNumber	form	string	No
AccountNumber	form	string	No

**CreatePaymentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Payment	form	Payment	No

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 /payments HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	salaryPackageId: String,
	amount: 0,
	gstAmount: 0,
	particulars: String,
	budgetCategory: String,
	organisationId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	payment: 
	{
		salaryPackageId: String,
		amount: 0,
		gstAmount: 0,
		particulars: String,
		budgetCategory: String,
		status: String,
		toAccount: 
		{
			bsbNumber: String,
			accountNumber: String
		},
		id: String
	}
}