GET
/
v1
/
businesses
/
{businessId}
/
invoices
List invoices
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices \
  --header 'Authorization: Bearer <token>'
[
  {
    "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",
    "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"
        },
        "ledger_account": {
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Current Assets",
          "stable_name": {
            "type": "StableName",
            "stable_name": "CURRENT_ASSETS"
          },
          "normality": "CREDIT",
          "account_type": {
            "value": "ASSET",
            "display_name": "Asset"
          },
          "account_subtype": {
            "value": "BANK_ACCOUNTS",
            "display_name": "Current Assets"
          }
        },
        "prepayment_account": {
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Current Assets",
          "stable_name": {
            "type": "StableName",
            "stable_name": "CURRENT_ASSETS"
          },
          "normality": "CREDIT",
          "account_type": {
            "value": "ASSET",
            "display_name": "Asset"
          },
          "account_subtype": {
            "value": "BANK_ACCOUNTS",
            "display_name": "Current Assets"
          }
        },
        "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"
            },
            "tax_ledger_account": {
              "id": "c4007474-f604-4d57-9690-b7f40f7a1cee",
              "name": "Sales tax: CALIFORNIA",
              "stable_name": "SALES_TAXES_PAYABLE:CALIFORNIA",
              "normality": "CREDIT",
              "account_type": {
                "value": "LIABILITY",
                "display_name": "Liabilities"
              },
              "account_subtype": {
                "value": "SALES_TAXES_PAYABLE",
                "display_name": "Sales Taxes Payable"
              }
            },
            "amount": 123
          }
        ],
        "total_amount": 123,
        "refund_allocations": [],
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ],
    "subtotal": 123,
    "additional_discount": 123,
    "additional_sales_taxes_total": 123,
    "additional_sales_taxes": [
      {
        "tax_account": {
          "type": "Tax_Name",
          "name": "CALIFORNIA_VAT"
        },
        "tax_ledger_account": {
          "id": "c4007474-f604-4d57-9690-b7f40f7a1cee",
          "name": "Sales tax: CALIFORNIA",
          "stable_name": "SALES_TAXES_PAYABLE:CALIFORNIA",
          "normality": "CREDIT",
          "account_type": {
            "value": "LIABILITY",
            "display_name": "Liabilities"
          },
          "account_subtype": {
            "value": "SALES_TAXES_PAYABLE",
            "display_name": "Sales Taxes Payable"
          }
        },
        "amount": 123
      }
    ],
    "tips": 123,
    "total_amount": 123,
    "outstanding_balance": 123,
    "memo": "<string>",
    "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",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 10kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    },
    "reference_number": "<string>"
  }
]

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 fetch invoices for

Query Parameters

status
string

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.

due_at_start
string<date-time>

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.

due_at_end
string<date-time>

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.

sent_at_start
string<date-time>

Filter invoices by sent date. Invoices with a sent date on or after this date will be included. ISO 8601 date format.

sent_at_end
string<date-time>

Filter invoices by sent date. Invoices with a sent date on or before this date will be included. ISO 8601 date format.

customer_id
string<uuid>

Filter invoices by Layer customer id.

customer_external_id
string

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.

reference_numbers
string

Comma-separated list of reference numbers to filter invoices by. Only invoices with reference numbers matching any value in this list will be returned.

min_amount
integer

Filter invoices by minimum total amount (in positive cents)

Required range: x >= 0
max_amount
integer

Filter invoices by maximum total amount (in positive cents)

Required range: x >= 0
memo
string

Filter invoices by exact memo match.

memo_contains
string

Filter invoices where memo contains this substring.

Response

200
application/json

The response is of type object[].