PUT
/
v1
/
businesses
/
{businessId}
/
invoices
/
{invoiceId}
curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "019234",
  "sent_at": "2023-11-07T05:31:56Z",
  "due_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z",
  "invoice_number": "1",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "<string>",
  "line_items": [
    {
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "external_id": "<string>",
      "description": "Line item description",
      "product": "Widgets",
      "unit_price": 123,
      "quantity": 123,
      "discount_amount": 123,
      "sales_taxes": [
        {
          "tax_account": {
            "type": "Tax_Name",
            "name": "CALIFORNIA_VAT"
          },
          "amount": 123
        }
      ],
      "is_prepayment": true
    }
  ],
  "additional_sales_taxes": [
    {
      "tax_account": {
        "type": "Tax_Name",
        "name": "CALIFORNIA_VAT"
      },
      "amount": 123
    }
  ],
  "additional_discount": 123,
  "tips": 123,
  "tips_account": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "Invoice",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "1",
  "status": "SENT",
  "sent_at": "2023-11-07T05:31:56Z",
  "due_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z",
  "invoice_number": "1",
  "line_items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "Widget sale",
      "product": "Widget",
      "unit_price": 123,
      "quantity": 123,
      "subtotal": 123,
      "discount_amount": 123,
      "sales_taxes_total": 123,
      "sales_taxes": [
        {
          "tax_account": {
            "type": "Tax_Name",
            "name": "CALIFORNIA_VAT"
          },
          "amount": 123
        }
      ],
      "total_amount": 123
    }
  ],
  "subtotal": 123,
  "additional_discount": 123,
  "additional_sales_taxes_total": 123,
  "additional_sales_taxes": [
    {
      "tax_account": {
        "type": "Tax_Name",
        "name": "CALIFORNIA_VAT"
      },
      "amount": 123
    }
  ],
  "tips": 123,
  "total_amount": 123,
  "outstanding_balance": 123,
  "payment_allocations": [],
  "refund_allocations": [],
  "imported_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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 update the invoice for

​
invoiceId
string
required

The UUID of the invoice to update

Body

application/json
​
external_id
string

External ID for the invoice within your platform. Idempotency key.

Example:

"019234"

​
sent_at
string

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

​
due_at
string

When the invoice is due.

​
voided_at
string

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

​
invoice_number
string

Number for the invoice for display to end-users.

Example:

"1"

​
customer_id
string

ID of the customer to associate with the invoice.

​
customer_external_id
string

External ID of the customer to associate with the invoice.

​
line_items
object[]

Line items making up the invoice.

​
additional_sales_taxes
object[]

List of sales tax obligations on this line item.

​
additional_discount
integer

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

​
tips
integer

Tips included by the buyer, in cents.

​
tips_account
object

The Account Identifier for a tips account.

Response

200 - application/json
Invoice updated successfully
​
id
string

Unique identifier for the invoice.

​
type
string

Resource type. Value will be 'Invoice'.

Example:

"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.

Example:

"1"

​
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.

Example:

"1"

​
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.

Example:
[]
​
refund_allocations
object[]

Refunds made by a customer are allocated toward one or many invoices. This list shows which refunds have been been allocated towards this invoice.

Example:
[]
​
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

Fetch invoiceVoid an Invoice