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>"
  }
]

GET

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

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

Show child attributes

line_items.id

string<uuid>

ID of the bill line item.

line_items.external_id

string | null

The external ID of the bill line item in your system.

line_items.bill_id

string<uuid>

ID of the parent bill

line_items.account_identifier

Account ID · object

Account identifier for the line item

Account ID
Account Stable Name

Show child attributes

line_items.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

line_items.account_identifier.id

string<uuid>

ID of the account

line_items.ledger_account

object

Ledger account for the line item

Show child attributes

line_items.ledger_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

line_items.ledger_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

line_items.ledger_account.id.id

string<uuid>

ID of the account

line_items.ledger_account.name

string

Name of the account

Example:

"Current Assets"

line_items.ledger_account.account_number

string | null

Account number if configured

Example:

"4000"

line_items.ledger_account.stable_name

object

Show child attributes

line_items.ledger_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

line_items.ledger_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

line_items.ledger_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

line_items.ledger_account.account_type

object

Show child attributes

line_items.ledger_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

line_items.ledger_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

line_items.ledger_account.account_subtype

object

Show child attributes

line_items.ledger_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

line_items.ledger_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

line_items.prepayment_account

object

Ledger account for the line item used for accrual reporting. Should only be specified when this line item is a pre-payment.

Show child attributes

line_items.prepayment_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

line_items.prepayment_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

line_items.prepayment_account.id.id

string<uuid>

ID of the account

line_items.prepayment_account.name

string

Name of the account

Example:

"Current Assets"

line_items.prepayment_account.account_number

string | null

Account number if configured

Example:

"4000"

line_items.prepayment_account.stable_name

object

Show child attributes

line_items.prepayment_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

line_items.prepayment_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

line_items.prepayment_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

line_items.prepayment_account.account_type

object

Show child attributes

line_items.prepayment_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

line_items.prepayment_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

line_items.prepayment_account.account_subtype

object

Show child attributes

line_items.prepayment_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

line_items.prepayment_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

line_items.description

string | null

Description for the bill line item

line_items.product_name

string

Name of the product/service

line_items.unit_price

integer<int64>

Price per unit in cents

line_items.quantity

number<bigdecimal>

Number of units

line_items.subtotal

integer<int64>

Subtotal for the line item in cents

line_items.discount_amount

integer<int64>

Amount of discount in cents

line_items.sales_taxes

object[]

Sales tax line items

Show child attributes

line_items.sales_taxes.amount

integer<int64>

required

Tax amount in cents

line_items.sales_taxes.tax_rate

number<float>

required

Tax rate as a decimal (e.g., 0.08 for 8%)

line_items.sales_taxes.tax_rate_id

string<uuid>

required

ID of the tax rate

line_items.sales_taxes.tax_rate_name

string

Display name of the tax rate

line_items.sales_taxes_total

integer<int64>

Total sales tax in cents

line_items.total_amount

integer<int64>

Total amount including taxes and discounts

line_items.transaction_tags

object[]

Tags for the bill line item

Show child attributes

line_items.transaction_tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

line_items.transaction_tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

line_items.transaction_tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

line_items.transaction_tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

additional_sales_taxes

object[]

Additional sales tax line items

Show child attributes

additional_sales_taxes.amount

integer<int64>

required

Tax amount in cents

additional_sales_taxes.tax_rate

number<float>

required

Tax rate as a decimal (e.g., 0.08 for 8%)

additional_sales_taxes.tax_rate_id

string<uuid>

required

ID of the tax rate

additional_sales_taxes.tax_rate_name

string

Display name of the tax rate

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

Show child attributes

payment_allocations.id

string<uuid>

Unique identifier for the allocation

payment_allocations.bill_id

string<uuid>

ID of the bill

payment_allocations.payment_id

string<uuid>

ID of the payment

payment_allocations.amount

integer<int64>

Amount allocated in cents

payment_allocations.payment

object

The full payment details

Show child attributes

payment_allocations.payment.id

string<uuid>

Unique identifier for the payment

payment_allocations.payment.external_id

string | null

External ID for the payment

payment_allocations.payment.at

string<date-time>

When the payment was made

payment_allocations.payment.method

enum<string>

Method used for payment

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

payment_allocations.payment.amount

integer<int64>

Payment amount in cents

payment_allocations.payment.processor

string | null

Payment processor used

payment_allocations.payment.payment_clearing_account

object

The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.

Show child attributes

payment_allocations.payment.payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

payment_allocations.payment.payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payment_allocations.payment.payment_clearing_account.id.id

string<uuid>

ID of the account

payment_allocations.payment.payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

payment_allocations.payment.payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

payment_allocations.payment.payment_clearing_account.stable_name

object

Show child attributes

payment_allocations.payment.payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

payment_allocations.payment.payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

payment_allocations.payment.payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

payment_allocations.payment.payment_clearing_account.account_type

object

Show child attributes

payment_allocations.payment.payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

payment_allocations.payment.payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

payment_allocations.payment.payment_clearing_account.account_subtype

object

Show child attributes

payment_allocations.payment.payment_clearing_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

payment_allocations.payment.payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

payment_allocations.payment.imported_at

string<date-time>

When the payment was imported

payment_allocations.payment.allocations

object[]

How the payment is allocated across bills

Show child attributes

payment_allocations.payment.allocations.id

string<uuid>

Unique identifier for the allocation

payment_allocations.payment.allocations.bill_id

string<uuid>

ID of the bill

payment_allocations.payment.allocations.payment_id

string<uuid>

ID of the payment

payment_allocations.payment.allocations.amount

integer<int64>

Amount allocated in cents

payment_allocations.payment.allocations.transaction_tags

object[]

Tags associated with the allocation

Show child attributes

payment_allocations.payment.allocations.transaction_tags.id

string<uuid>

required

ID for the tag

payment_allocations.payment.allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payment_allocations.payment.allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payment_allocations.payment.allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payment_allocations.payment.allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payment_allocations.payment.allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payment_allocations.payment.allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payment_allocations.payment.allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payment_allocations.payment.allocations.memo

string | null

Memo for any text you would like to associate with the bill payment allocation (for example, to display to end users).

payment_allocations.payment.allocations.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": [] }
}

payment_allocations.payment.allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the bill payment allocation.

payment_allocations.payment.transaction_tags

object[]

Tags associated with the payment

Show child attributes

payment_allocations.payment.transaction_tags.id

string<uuid>

required

ID for the tag

payment_allocations.payment.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payment_allocations.payment.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payment_allocations.payment.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payment_allocations.payment.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payment_allocations.payment.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payment_allocations.payment.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payment_allocations.payment.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payment_allocations.payment.memo

string | null

Memo for any text you would like to associate with the bill payment (for example, to display to end users).

payment_allocations.payment.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": [] }
}

payment_allocations.payment.reference_number

string | null

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

payment_allocations.transaction_tags

object[]

Tags associated with the allocation

Show child attributes

payment_allocations.transaction_tags.id

string<uuid>

required

ID for the tag

payment_allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payment_allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payment_allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payment_allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payment_allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payment_allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payment_allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payment_allocations.memo

string | null

Memo for any text you would like to associate with the bill payment allocation (for example, to display to end users).

payment_allocations.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": [] }
}

payment_allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the bill payment allocation.

vendor_credits

object[]

Vendor credit allocations for this bill

Show child attributes

vendor_credits.id

string<uuid>

required

Unique identifier for the vendor credit allocation

vendor_credits.vendor_credit_id

string<uuid>

required

UUID of the vendor credit this allocation belongs to

vendor_credits.amount

integer<int64>

required

Amount for the allocation in cents

vendor_credits.vendor_credit

object

required

The vendor credit associated with this allocation

Show child attributes

vendor_credits.vendor_credit.id

string<uuid>

required

Unique identifier for the vendor credit

vendor_credits.vendor_credit.vendor

object

required

The vendor associated with this credit

Show child attributes

vendor_credits.vendor_credit.vendor.id

string<uuid>

Unique identifier for the vendor.

vendor_credits.vendor_credit.vendor.external_id

string

Unique ID of the vendor in your system for linking purposes. Idempotency key.

vendor_credits.vendor_credit.vendor.individual_name

string | null

Full name of the individual vendor or contact at a corporate vendor.

vendor_credits.vendor_credit.vendor.company_name

string | null

Name of the company vendor.

vendor_credits.vendor_credit.vendor.email

string | null

Email address of the vendor.

vendor_credits.vendor_credit.vendor.mobile_phone

string | null

Mobile phone number of the vendor.

vendor_credits.vendor_credit.vendor.office_phone

string | null

Office phone number of the vendor.

vendor_credits.vendor_credit.vendor.address_string

string | null

Address of the vendor.

vendor_credits.vendor_credit.vendor.memo

string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

vendor_credits.vendor_credit.vendor.status

enum<string>

Status of the vendor.

Available options:

ACTIVE,

ARCHIVED

vendor_credits.vendor_credit.vendor.transaction_tags

object[]

Show child attributes

vendor_credits.vendor_credit.vendor.transaction_tags.id

string<uuid>

required

ID for the tag

vendor_credits.vendor_credit.vendor.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

vendor_credits.vendor_credit.vendor.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

vendor_credits.vendor_credit.vendor.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

vendor_credits.vendor_credit.vendor.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

vendor_credits.vendor_credit.vendor.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

vendor_credits.vendor_credit.vendor.transaction_tags.value_display_name

string | null

Display name for the tag value definition

vendor_credits.vendor_credit.vendor.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

vendor_credits.vendor_credit.received_at

string<date-time>

required

Timestamp when the vendor credit was received

vendor_credits.vendor_credit.line_items

object[]

required

List of line items for this vendor credit

Show child attributes

vendor_credits.vendor_credit.line_items.id

string<uuid>

required

Unique identifier for the vendor credit line item

vendor_credits.vendor_credit.line_items.amount

integer<int64>

required

Amount for the line item in cents

vendor_credits.vendor_credit.line_items.ledger_account

object

Ledger account for this line item

Show child attributes

vendor_credits.vendor_credit.line_items.ledger_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

vendor_credits.vendor_credit.line_items.ledger_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

vendor_credits.vendor_credit.line_items.ledger_account.id.id

string<uuid>

ID of the account

vendor_credits.vendor_credit.line_items.ledger_account.name

string

Name of the account

Example:

"Current Assets"

vendor_credits.vendor_credit.line_items.ledger_account.account_number

string | null

Account number if configured

Example:

"4000"

vendor_credits.vendor_credit.line_items.ledger_account.stable_name

object

Show child attributes

vendor_credits.vendor_credit.line_items.ledger_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

vendor_credits.vendor_credit.line_items.ledger_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

vendor_credits.vendor_credit.line_items.ledger_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

vendor_credits.vendor_credit.line_items.ledger_account.account_type

object

Show child attributes

vendor_credits.vendor_credit.line_items.ledger_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

vendor_credits.vendor_credit.line_items.ledger_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

vendor_credits.vendor_credit.line_items.ledger_account.account_subtype

object

Show child attributes

vendor_credits.vendor_credit.line_items.ledger_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

vendor_credits.vendor_credit.line_items.ledger_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

vendor_credits.vendor_credit.line_items.memo

string

Description for the line item

vendor_credits.vendor_credit.line_items.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": [] }
}

vendor_credits.vendor_credit.line_items.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor credit line item.

vendor_credits.vendor_credit.line_items.transaction_tags

object[]

List of tags associated with this vendor credit line item

Show child attributes

vendor_credits.vendor_credit.line_items.transaction_tags.id

string<uuid>

required

ID for the tag

vendor_credits.vendor_credit.line_items.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

vendor_credits.vendor_credit.line_items.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

vendor_credits.vendor_credit.line_items.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

vendor_credits.vendor_credit.line_items.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

vendor_credits.vendor_credit.line_items.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

vendor_credits.vendor_credit.line_items.transaction_tags.value_display_name

string | null

Display name for the tag value definition

vendor_credits.vendor_credit.line_items.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

vendor_credits.vendor_credit.created_at

string<date-time>

required

Timestamp when the vendor credit was created

vendor_credits.vendor_credit.updated_at

string<date-time>

required

Timestamp when the vendor credit was last updated

vendor_credits.vendor_credit.transaction_tags

object[]

required

List of tags associated with this vendor credit

Show child attributes

vendor_credits.vendor_credit.transaction_tags.id

string<uuid>

required

ID for the tag

vendor_credits.vendor_credit.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

vendor_credits.vendor_credit.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

vendor_credits.vendor_credit.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

vendor_credits.vendor_credit.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

vendor_credits.vendor_credit.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

vendor_credits.vendor_credit.transaction_tags.value_display_name

string | null

Display name for the tag value definition

vendor_credits.vendor_credit.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

vendor_credits.vendor_credit.external_id

string

External identifier for the vendor credit

vendor_credits.vendor_credit.allocations

object[]

List of allocations for this vendor credit

Show child attributes

vendor_credits.vendor_credit.allocations.id

string<uuid>

required

Unique identifier for the vendor credit allocation

vendor_credits.vendor_credit.allocations.vendor_credit_id

string<uuid>

required

UUID of the vendor credit this allocation belongs to

vendor_credits.vendor_credit.allocations.amount

integer<int64>

required

Amount for the allocation in cents

vendor_credits.vendor_credit.allocations.bill_id

string<uuid>

UUID of the bill this allocation is for

vendor_credits.vendor_credit.deleted_at

string<date-time>

Timestamp when the vendor credit was deleted, if applicable

vendor_credits.vendor_credit.memo

string | null

Memo for any text you would like to associate with the vendor credit (for example, to display to end users).

vendor_credits.vendor_credit.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": [] }
}

vendor_credits.vendor_credit.reference_number

string | null

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

vendor_credits.bill_id

string<uuid>

UUID of the bill this allocation is for

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

Show child attributes

vendor.id

string<uuid>

Unique identifier for the vendor.

vendor.external_id

string

Unique ID of the vendor in your system for linking purposes. Idempotency key.

vendor.individual_name

string | null

Full name of the individual vendor or contact at a corporate vendor.

vendor.company_name

string | null

Name of the company vendor.

vendor.email

string | null

Email address of the vendor.

vendor.mobile_phone

string | null

Mobile phone number of the vendor.

vendor.office_phone

string | null

Office phone number of the vendor.

vendor.address_string

string | null

Address of the vendor.

vendor.memo

string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

vendor.status

enum<string>

Status of the vendor.

Available options:

ACTIVE,

ARCHIVED

vendor.transaction_tags

object[]

Show child attributes

vendor.transaction_tags.id

string<uuid>

required

ID for the tag

vendor.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

vendor.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

vendor.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

vendor.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

vendor.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

vendor.transaction_tags.value_display_name

string | null

Display name for the tag value definition

vendor.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

transaction_tags

object[]

Show child attributes

transaction_tags.id

string<uuid>

required

ID for the tag

transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

transaction_tags.value_display_name

string | null

Display name for the tag value definition

transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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.

Bill object Fetch bill

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

List bills

Authorizations

Path Parameters

Query Parameters

Response