Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
bills
List bills
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "status": "RECEIVED",
    "terms": "DUE_ON_RECEIPT",
    "received_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",
    "memo": "<string>",
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "bill_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",
          "account_number": "4000",
          "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",
          "account_number": "4000",
          "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": "<string>",
        "product_name": "<string>",
        "unit_price": 123,
        "quantity": 123,
        "subtotal": 123,
        "discount_amount": 123,
        "sales_taxes": [
          {
            "amount": 123,
            "tax_rate": 123,
            "tax_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tax_rate_name": "<string>"
          }
        ],
        "sales_taxes_total": 123,
        "total_amount": 123,
        "transaction_tags": [
          {
            "key": "department",
            "value": "sales",
            "dimension_display_name": "Department",
            "value_display_name": "Sales Department"
          }
        ]
      }
    ],
    "additional_sales_taxes": [
      {
        "amount": 123,
        "tax_rate": 123,
        "tax_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tax_rate_name": "<string>"
      }
    ],
    "additional_sales_taxes_total": 123,
    "subtotal": 123,
    "total_amount": 123,
    "outstanding_balance": 123,
    "payment_allocations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "payment": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "at": "2023-11-07T05:31:56Z",
          "method": "CASH",
          "amount": 123,
          "processor": "<string>",
          "payment_clearing_account": {
            "id": {
              "type": "AccountId",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "name": "Current Assets",
            "account_number": "4000",
            "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"
            }
          },
          "imported_at": "2023-11-07T05:31:56Z",
          "allocations": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "amount": 123,
              "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",
                  "dimension_display_name": "<string>",
                  "value_display_name": "<string>",
                  "archived_at": "2023-11-07T05:31:56Z"
                }
              ],
              "memo": "<string>",
              "metadata": {
                "custom_field": "value",
                "any valid json": "below 1kb",
                "nested": {
                  "meaning of life": 42,
                  "array": []
                }
              },
              "reference_number": "<string>"
            }
          ],
          "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",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        },
        "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",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "vendor_credits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendor_credit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "vendor_credit": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "vendor": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "<string>",
            "individual_name": "<string>",
            "company_name": "<string>",
            "email": "<string>",
            "mobile_phone": "<string>",
            "office_phone": "<string>",
            "address_string": "<string>",
            "memo": "<string>",
            "status": "ACTIVE",
            "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",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ]
          },
          "received_at": "2023-11-07T05:31:56Z",
          "line_items": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "amount": 123,
              "ledger_account": {
                "id": {
                  "type": "AccountId",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                },
                "name": "Current Assets",
                "account_number": "4000",
                "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"
                }
              },
              "memo": "<string>",
              "metadata": {
                "custom_field": "value",
                "any valid json": "below 1kb",
                "nested": {
                  "meaning of life": 42,
                  "array": []
                }
              },
              "reference_number": "<string>",
              "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",
                  "dimension_display_name": "<string>",
                  "value_display_name": "<string>",
                  "archived_at": "2023-11-07T05:31:56Z"
                }
              ]
            }
          ],
          "created_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",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "external_id": "<string>",
          "allocations": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "vendor_credit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "amount": 123,
              "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "deleted_at": "2023-11-07T05:31:56Z",
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        },
        "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "imported_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "vendor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "individual_name": "<string>",
      "company_name": "<string>",
      "email": "<string>",
      "mobile_phone": "<string>",
      "office_phone": "<string>",
      "address_string": "<string>",
      "memo": "<string>",
      "status": "ACTIVE",
      "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",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_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",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 1kb",
      "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.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business to fetch bills for

Query Parameters

​
reference_numbers
string

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

​
status
enum<string>

Filter bills by status.

Available options:
RECEIVED,
PARTIALLY_PAID,
PAID,
VOIDED
​
due_at_start
string<date-time>

Filter bills by due date. Bills with a due date on or after this date will be included. Bills without a set due date will not be included. ISO 8601 date format.

​
due_at_end
string<date-time>

Filter bills by due date. Bills with a due date on or before this date will be included. Bills without a set due date will not be included. ISO 8601 date format.

​
received_at_start
string<date-time>

Filter bills by received date. Bills received on or after this date will be included. ISO 8601 date format.

​
received_at_end
string<date-time>

Filter bills by received date. Bills received on or before this date will be included. ISO 8601 date format.

​
vendor_id
string<uuid>

Filter bills by Layer vendor id.

​
vendor_external_id
string

Filter bills by vendor external id. Either the vendor_id or the vendor_external_id can be provided.

​
min_amount
integer<int64>

Filter bills by minimum total amount (in positive cents)

​
max_amount
integer<int64>

Filter bills by maximum total amount (in positive cents)

Response

200 - application/json

Success

​
id
string<uuid>

Unique identifier for the bill.

​
business_id
string<uuid>

ID of the Business that received the bill.

​
external_id
string | null

Unique ID of the bill in your system.

​
status
enum<string>

Status of the bill.

Available options:
RECEIVED,
PARTIALLY_PAID,
PAID,
VOIDED
​
terms
enum<string>

Payment terms of the bill.

Available options:
DUE_ON_RECEIPT,
NET_10,
NET_15,
NET_30,
NET_60
​
received_at
string<date-time>

When the bill was received.

​
due_at
string<date-time> | null

When the bill is due.

​
paid_at
string<date-time> | null

When the bill was paid.

​
voided_at
string<date-time> | null

When the bill was voided.

​
memo
string

Memo for the bill for display.

​
line_items
object[]

Line items making up the bill

​
additional_sales_taxes
object[]

Additional sales tax line items

​
additional_sales_taxes_total
integer

Sum of all additional taxes in cents

​
subtotal
integer

Subtotal of all line items in cents

​
total_amount
integer

Total amount including taxes in cents

​
outstanding_balance
integer

Remaining balance after payments in cents

​
payment_allocations
object[]

Payment allocations for this bill

​
vendor_credits
object[]

Vendor credit allocations for this bill

​
imported_at
string<date-time>

When the bill was imported

​
updated_at
string<date-time>

When the bill was last updated

​
vendor
object

The vendor associated with this bill

​
transaction_tags
object[]
​
metadata
object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:
{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}
​
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the bill. Can be used to filter when listing bills.