Get Invoice by Nabis ID
Returns a single invoice your organization pays or is paid for.
Path Parameters
- id uuid required
Nabis ID of the invoice
- 200
- 401
- 404
- 429
Successful Operation
Response Headers
X-RateLimit-Limit integer
Requests per minute your access token can make
X-RateLimit-Remaining integer
Requests you can still make right now, after this one
X-RateLimit-Reset integer
Seconds until your oldest request in the last minute stops counting, freeing up room for another. Not a countdown to your whole limit refilling: each request stops counting one minute after you make it
- application/json
- Schema
Schema
- id uuid
Nabis ID of the invoice
- number integer
Invoice number
- name string
Name of the invoice
- orderId uuid
Nabis ID of the order the invoice is for.
nullfor invoices that aren't tied to an order. See Get Order by Nabis ID - groupType string
Possible values: [
ORDER,FEE,BASE]Kind of invoice.
ORDERis the retailer's invoice for an order;FEEandBASEare fees - paidByOrganizationId uuid
Nabis ID of the organization that pays the invoice
- paidByOrganizationName string
Name of the organization that pays the invoice
- paidToOrganizationId uuid
Nabis ID of the organization the invoice is paid to
- paidToOrganizationName string
Name of the organization the invoice is paid to
- collectionStatus string
Possible values: [
UNFINISHED,FINISHED]Whether Nabis is still collecting on the invoice (
UNFINISHED) or is done (FINISHED) - dueDate date
Date the invoice is due, in
yyyy-mm-ddformat - netTerms integer
Number of days after delivery the invoice is due.
0when due on delivery - publicNotes string
Notes on the invoice
- subtotal number
Amount invoiced before tax, discounts and credits
- discount number
Discounts applied to the invoice
- creditMemo number
Total of the credit memos applied to the invoice
- deduction number
Deductions applied to the invoice
- writeOff number
Amount written off as uncollectable
- collected number
Amount collected on the invoice so far
- balanceDue number
Amount still owed on the invoice
- tax number
Tax on the order. Only set on
ORDERinvoices. - surchargeAmount number
Surcharge on the order. Only set on
ORDERinvoices. - paymentStatus string
Possible values: [
UNPAID,COD_PAID,NET_TERMS_PAID,REMITTED,SELF_COLLECTED,PROCESSING,PAYMENT_SENT,WRITE_OFF,THIRD_PARTY_COLLECTIONS,PARTIAL_PAID,DRIVER_PROCESSING]Payment status of the order. Only set on
ORDERinvoices. - paidAt date-time
When the order was paid in full. Only set on
ORDERinvoices. - remittedAt date-time
When payment for the order was remitted to the brand. Only set on
ORDERinvoices. creditMemos object[]
Credit memos applied to the order. Only set on
ORDERinvoices. Empty on other invoicesid uuidNabis ID of the credit memo
amount numberAmount of the credit memo
creditMemoType stringPossible values: [
ACCOUNT_CREDIT,FAULTY_HARDWARE_CREDIT,MANUFACTURING_ERROR_CREDIT,MARKETING_CREDIT,PROMOTIONAL_CREDIT,RETURN_CREDIT,ROLLOVER_OVERPAYMENT_CREDIT,SALES_CREDIT,SETTLEMENT_CREDIT]Reason for the credit memo
notes stringNotes on the credit memo
createdAt date-timeWhen the credit memo was created
creditMemoCreatedBy object
The user who created a credit memo. Only their ID, name and email address are shared
id uuidNabis ID of the user
firstName stringUser's first name
lastName stringUser's last name
email emailUser's email address
- createdAt date-time
When the invoice was created
- updatedAt date-time
When the invoice was last updated
Invalid API key
Not Found
Too Many Requests. You've used up your rate limit; wait Retry-After seconds and try again
Response Headers
Retry-After integer
Seconds to wait before making another request
X-RateLimit-Limit integer
Requests per minute your access token can make
X-RateLimit-Remaining integer
Requests you can still make right now, after this one
X-RateLimit-Reset integer
Seconds until your oldest request in the last minute stops counting, freeing up room for another. Not a countdown to your whole limit refilling: each request stops counting one minute after you make it