Retrieve an invoice
Retrieves a Invoice resource.
Authorizations:Token, JWT
Query Parameters
order_id required | stringInvoice identifier |
id required | stringInvoice identifier |
Responses
200Invoice resource
Response schema:
Invoice resource invoiceNumber | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||
profile | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||
customerNotes | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||
adminNotes | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||
items | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
surcharges | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentTransactions | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string3 characters | ||||||||||||||||||||||||||||||||||||||||||||||||||||
subtotal | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||
total | number | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | integer or null>= 1 |
401Unauthorized
Response schema:
Unauthorized type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |
404Resource not found
Response schema:
Resource not found type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |
500Internal error
Response schema:
Internal error type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |