Billiecart API

<back to all web services

GetPaymentRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/payments/{Id}
GetPaymentRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetPaymentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PaymentformPaymentNo
Payment Parameters:
NameParameterData TypeRequiredDescription
SalaryPackageIdformstringNo
AmountformdecimalNo
GstAmountformdecimalNo
ParticularsformstringNo
BudgetCategoryformstringNo
StatusformstringNo
ToAccountformBankAccountNo
IdformstringNo
BankAccount Parameters:
NameParameterData TypeRequiredDescription
BsbNumberformstringNo
AccountNumberformstringNo
GetPaymentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PaymentformPaymentNo

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.

GET /payments/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
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
	}
}