GET
/
v1
/
businesses
/
{businessId}
/
bills
/
bill-payments
List bill payments
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/bill-payments \
  --header 'Authorization: Bearer <token>'
[
  {
    "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",
      "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",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 10kb",
          "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",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "memo": "<string>",
    "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.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business to fetch bill payments for

Query Parameters

​
reference_numbers
string

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

​
method
enum<string>

Filter payments by method.

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
CREDIT_BALANCE,
OTHER
​
paid_at_start
string<date-time>

Filter payments by payment date. Payments made on or after this date will be included.

​
paid_at_end
string<date-time>

Filter payments by payment date. Payments made on or before this date will be included.

​
external_id
string

Filter payments by external ID (unique idempotency key). This will always yield zero or one result.

​
is_matched
boolean

Filter bill payments by match status. If true, only matched payments will be returned. If false, only unmatched payments will be returned. Bill payments are considered matched if they are matched directly, or if they are included in a vendor payout that is matched.

Response

200 - application/json

Success

​
id
string<uuid>

Unique identifier for the payment

​
external_id
string | null

External ID for the payment

​
at
string<date-time>

When the payment was made

​
method
enum<string>

Method used for payment

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
CREDIT_BALANCE,
OTHER
​
amount
integer

Payment amount in cents

​
processor
string | null

Payment processor used

​
payment_clearing_account
object

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

​
imported_at
string<date-time>

When the payment was imported

​
allocations
object[]

How the payment is allocated across bills

​
transaction_tags
object[]

Tags associated with the payment

​
memo
string | null

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

​
metadata
object

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

Example:
{
  "custom_field": "value",
  "any valid json": "below 10kb",
  "nested": { "meaning of life": 42, "array": [] }
}
​
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.