Retrieve Invoice
GET/accounting/invoices/:id
Retrieve an Invoice with the given id.
Request
Path Parameters
id stringrequired
The ID of the invoice.
Query Parameters
credentialId stringrequired
The ID of the credential.
Header Parameters
Authorization stringrequired
Default value: bearer YOUR_API_KEY
Responses
- 200
- 400
200
- application/json
- Schema
- Example (from schema)
- Result
Schema
Array [
]
invoice
object
remoteId string
customerId
invoiceNumber string
issueDate integer
Default value: 0
dueDate integer
Default value: 0
paidOnDate
memo
companyId
currency string
exchangeRate
totalDiscount string
subTotal string
invoiceStatus
totalTaxAmount
totalAmount number
Default value: 0
balance number
Default value: 0
trackingCategories array
lineItems
object[]
id
remoteId
description string
unitPrice
quantity
totalAmount number
Default value: 0
currency string
exchangeRate
accountingItemId
accountId
trackingCategoryId
trackingCategoryIds array
companyId
purchaseOrders array
id string
remoteCreatedAt string
remoteUpdatedAt string
remoteDeleted boolean
Default value: true
createdAt string
updatedAt string
{
"invoice": {
"remoteId": "1",
"customerId": {},
"invoiceNumber": "1001",
"issueDate": 1700179200,
"dueDate": 1702771200,
"paidOnDate": {},
"memo": {},
"companyId": {},
"currency": "USD",
"exchangeRate": {},
"totalDiscount": "0",
"subTotal": "4.99",
"invoiceStatus": {},
"totalTaxAmount": {},
"totalAmount": 4.99,
"balance": 4.99,
"trackingCategories": [
null
],
"lineItems": [
{
"id": {},
"remoteId": {},
"description": "test",
"unitPrice": {},
"quantity": {},
"totalAmount": 4.99,
"currency": "USD",
"exchangeRate": {},
"accountingItemId": {},
"accountId": {},
"trackingCategoryId": {},
"trackingCategoryIds": [
null
],
"companyId": {}
}
],
"purchaseOrders": [
null
],
"id": "74236957-cd0d-4452-9b1c-7afd54734fd9",
"remoteCreatedAt": "2023-07-11T08:01:53.000Z",
"remoteUpdatedAt": "2023-07-11T08:01:53.000Z",
"remoteDeleted": false,
"createdAt": "2024-02-22T11:15:58.607Z",
"updatedAt": "2024-02-22T13:51:03.813Z"
}
}
{
"invoice": {
"remoteId": "1",
"customerId": null,
"invoiceNumber": "1001",
"issueDate": 1700179200,
"dueDate": 1702771200,
"paidOnDate": null,
"memo": null,
"companyId": null,
"currency": "USD",
"exchangeRate": null,
"totalDiscount": "0",
"subTotal": "4.99",
"invoiceStatus": null,
"totalTaxAmount": null,
"totalAmount": 4.99,
"balance": 4.99,
"trackingCategories": [],
"lineItems": [
{
"id": null,
"remoteId": null,
"description": "test",
"unitPrice": null,
"quantity": null,
"totalAmount": 4.99,
"currency": "USD",
"exchangeRate": null,
"accountingItemId": null,
"accountId": null,
"trackingCategoryId": null,
"trackingCategoryIds": [],
"companyId": null
}
],
"purchaseOrders": [],
"id": "74236957-cd0d-4452-9b1c-7afd54734fd9",
"remoteCreatedAt": "2023-07-11T08:01:53.000Z",
"remoteUpdatedAt": "2023-07-11T08:01:53.000Z",
"remoteDeleted": false,
"createdAt": "2024-02-22T11:15:58.607Z",
"updatedAt": "2024-02-22T13:51:03.813Z"
}
}
400
- application/json
- Schema
- Example (from schema)
- Result
Schema
object
{}
{}
Loading...