Requires the role: | manager |
GET | /payments/{Id} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Payment | form | Payment | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BsbNumber | form | string | No | |
AccountNumber | form | string | No |
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
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 } }