List invoices
Returns a list of invoices for the specified business. Invoices can be filtered by status and date range. Results will be paginated, see Pagination for details.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json
Path Parameters
The UUID of the business to fetch invoices for
Query Parameters
Filter invoices by status.
SENT, PARTIALLY_PAID, PAID, VOIDED, PARTIALLY_WRITTEN_OFF, WRITTEN_OFF Filter invoices by due date. Invoices with a due date on or after this date will be included. Invoices without a set due date will not be included. ISO 8601 date format.
Filter invoices by due date. Invoices with a due date on or before this date will be included. Invoices without a set due date will not be included. ISO 8601 date format.
Filter invoices by sent date. Invoices with a sent date on or after this date will be included. ISO 8601 date format.
Filter invoices by sent date. Invoices with a sent date on or before this date will be included. ISO 8601 date format.
Filter invoices by Layer customer id.
Filter invoices by customer external id. Eiether the customer_id or the customer_external_id can be provided, but must match if both are provided.
Response
Unique identifier for the invoice.
Resource type. Value will be 'Invoice'.
ID of the Business that generated the invoice.
Unique ID of the invoice in your system for linking purposes.
Status of the invoice.
SENT, PARTIALLY_PAID, PAID, VOIDED, PARTIALLY_WRITTEN_OFF, WRITTEN_OFF When the invoice was sent by the business to the recipient.
When the invoice is due.
When the invoice was paid.
When the invoice was voided. Voiding excludes the invoice from accounting.
Number for the invoice for display to end-users.
Line items making up the invoice
Subtotal of all invoice line items in cents.
Additional discount applied to the whole invoice in addition to individual line items.
Sum of all taxes across the invoice line items and any additional taxes in cents.
List of additional sales tax line items
Tips included by the buyer, in cents.
Total amount of the invoice in cents.
The remaining balance on the invoice after factoring in all previous invoice payments and write-offs.
Payments made by a customer are allocated toward one or many invoices. This list shows which payments have been been allocated towards this invoice. The most common case is that there is a 1:1 relationship between a payment and an invoice, in which case the allocation’s amount will match the payment’s amount.
Time when the invoice was first imported into Layer. Eligible sort key.
Time when the invoice was first updated in Layer. Eligible sort key.
Tags on the transactions associated with the invoice