GET
/
v1
/
businesses
/
{businessId}
/
bills
/
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>",
    "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",
            "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": []
          }
        }
      }
    ],
    "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"
      }
    ],
    "memo": "<string>",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 10kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
businessId
string
required

The UUID of the business to fetch bill payments for

Query Parameters

​
method
enum<string>

Filter payments by method.

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
CREDIT_BALANCE,
OTHER
​
paid_at_start
string

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

​
paid_at_end
string

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.

Response

200 - application/json

Success

The response is of type object[].