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. Supports filtering by multiple statuses using two formats: 1) Comma-separated values: ?status=PAID,PARTIALLY_PAID 2) Multiple query parameters: ?status=PAID&status=PARTIALLY_PAID. Both formats return invoices matching any of the specified statuses.
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. Either the customer_id or the customer_external_id can be provided, but must match if both are provided.
Comma-separated list of reference numbers to filter invoices by. Only invoices with reference numbers matching any value in this list will be returned.
Filter invoices by minimum total amount (in positive cents)
x >= 0Filter invoices by maximum total amount (in positive cents)
x >= 0Filter invoices by exact memo match.
Filter invoices where memo contains this substring.
Response
Unique identifier for the invoice.
Resource type. Value will be 'Invoice'.
"Invoice"
ID of the Business that generated the invoice.
Unique ID of the invoice in your system for linking purposes.
"1"
Status of the invoice.
SENT, PARTIALLY_PAID, PAID, VOIDED, PARTIALLY_WRITTEN_OFF, WRITTEN_OFF, REFUNDED 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.
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.
Memo for any text you would like to associate with the Invoice (for example, to display to end users).
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.
[]Refunds made by a customer are allocated toward one or many invoices. This list shows which refunds have been been allocated towards this invoice.
[]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
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the invoice. Can be used to filter when listing invoices.