Get all invoice items.
Resource information | ||
|---|---|---|
Response format(s) | JSON | |
Requires authentication? | Yes using token | |
Request Header | ||
Name | Value | |
|
| |
|
| |
Parameters | ||
|
| Filter the items by statuses
|
|
| Filter the items by types
|
|
| Filter the items by transaction type
|
|
| Enter search data that can be used to search on each items. You can search by:
|
|
| Request field for pagination. The Page that you wish to view |
|
| The total items that return in the response |
|
| Sorting field, Default sorting is get all items sort by Values:
|
|
| Used in default: false |
Returns | ||
Returns all invoice items | ||
Response Header | ||
|---|---|---|
|
| |
Response Body | ||
Field | Type | Description |
|
| Invoice Number |
|
| |
|
| |
|
| Date time utc format |
|
| Date time utc format |
|
| Date time utc format |
|
| Type Of Invoice |
|
| |
|
| Sub Total |
|
| Total Fee |
|
| Total Receivable |
|
| Currency code of Sell Order |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Date time utc format |
|
| Date time utc format |
|
| |
|
| |
|
| |
|
| |
Request
GET /public/v2/invoices
Request
?Statuses=Paid&Statuses=Sending&Types=Trading&TransactionType=AccountsPayable
Response
200 Success
{
"Data": [
{
"InvoiceNumber": "INV-REAP-2023-07-13-00001",
"Quantity": 90,
"Total": 1240.29,
"IssuedDate": "2023-07-13T03:49:46.1656485",
"DueDate": "2023-07-22T23:59:59.9999999",
"PaidDate": null,
"Type": "Trading",
"TypeDescription": "Trading",
"SubTotal": 1176.3,
"TotalFee": 27.8865,
"TotalReceivable": 1240.2835,
"CreatedTime": "2023-07-13T03:49:46.43",
"UpdatedTime": "2023-07-13T03:50:22.88",
"CurrencyCode": "USD",
"CurrencySymbolic": "$",
"TaxPercent": 0.08,
"TaxAmount": 91.87,
"FeeCodeNumber": null,
"Status": "Unpaid",
"StatusDescription": "Unpaid",
}
],
"Meta": {
"CurrentPage": 1,
"TotalPage": 1,
"ItemsPerPage": 10,
"TotalItems": 1
},
"Errors": null,
"StatusCode": 200,
"Message": "Success"
}
400 Bad Request
{
"Data": null,
"Errors": null,
"Meta": null,
"StatusCode": 400,
"Message": "Bad request"
}
401 Unauthorized
{
"Data": null,
"Errors": null,
"Meta": null,
"StatusCode": 401,
"Message": "Unauthorized"
}
403 Forbidden
{
"Data": null,
"Errors": null,
"Meta": null,
"StatusCode": 403,
"Message": "Forbidden"
}