Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Invoices

Get invoice

Retrieves an invoice for the specified organization.

get/organizations/{organization_id}/invoices/{invoice_id}

Path parameters

invoice_idstring required

The ID of the invoice.

organization_idstring required

The ID of the organization.<br> Prefix with name= to retrieve the organization by name instead.

Response

OK

idstring

The invoice id.

invoice_numberstring

The invoice number.

type'invoice' | 'credit_memo'

Invoice type.

order_idstring

The id of the related order.

related_invoice_idstring nullable

If the invoice is a credit memo (type=credit_memo), this field stores the id of the related/original invoice.

status'paid' | 'charged_off' | 'pending' | 'refunded' | 'canceled' | 'refund_pending'

The invoice status.

ownerstring ulid

The ULID of the owner.

invoice_datestring date-time nullable

The invoice date.

invoice_duestring date-time nullable

The invoice due date.

createdstring date-time nullable

The time when the invoice was created.

changedstring date-time nullable

The time when the invoice was changed.

companystring

Company name (if any).

totalnumber double

The invoice total.

notesstring

The invoice note.