GET
/
v1
/
businesses
/
{businessId}
/
invoices
/
{invoiceId}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json

Path Parameters

businessId
string
required

The UUID of the business to fetch the invoice for

invoiceId
string
required

The UUID of the invoice to fetch

Response

200 - application/json
id
string

Unique identifier for the invoice.

type
string

Resource type. Value will be 'Invoice'.

business_id
string

ID of the Business that generated the invoice.

external_id
string

Unique ID of the invoice in your system for linking purposes.

status
enum<string>

Status of the invoice.

Available options:
SENT,
PARTIALLY_PAID,
PAID,
VOIDED,
PARTIALLY_WRITTEN_OFF,
WRITTEN_OFF
sent_at
string

When the invoice was sent by the business to the recipient.

due_at
string

When the invoice is due.

paid_at
string

When the invoice was paid.

voided_at
string

When the invoice was voided. Voiding excludes the invoice from accounting.

invoice_number
string

Number for the invoice for display to end-users.

line_items
object[]

Line items making up the invoice

subtotal
integer

Subtotal of all invoice line items in cents.

additional_discount
integer

Additional discount applied to the whole invoice in addition to individual line items.

additional_sales_taxes_total
integer

Sum of all taxes across the invoice line items and any additional taxes in cents.

additional_sales_taxes
object[]

List of additional sales tax line items

tips
integer

Tips included by the buyer, in cents.

total_amount
integer

Total amount of the invoice in cents.

outstanding_balance
integer

The remaining balance on the invoice after factoring in all previous invoice payments and write-offs.

payment_allocations
object[]

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.

imported_at
string

Time when the invoice was first imported into Layer. Eligible sort key.

updated_at
string

Time when the invoice was first updated in Layer. Eligible sort key.

transaction_tags
object[]

Tags on the transactions associated with the invoice