Bill payment object

Bill payments represent payments made by a business to vendors. Payments may be made at any time and applied to one or more outstanding (received, but not fully paid) bills.

Attributes

string

required

Unique identifier for the payment.

string

Unique ID of the bill payment in your system for linking and idempotency.

ISO8601 timestamp

required

Timestamp when the payment was completed.

enum

required

Payment method. Possible values are: CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER

integer

required

Payment amount, in cents.

string

Processor used to make the payment, if any. Any processor name can be provided and will be tracked.

ISO8601 timestamp

required

Timestamp when the payment was imported into Layer.

array of BillPaymentAllocation objects

required

Bill allocations allow specifying a payment to be for multiple bills. Most commonly the full payment will be allocated to a single bill, but any number of allocations are allowed. The sum of all allocations must be equal to the payment amount.

Show BillPaymentAllocation properties

string

required

Unique identifier for the allocation.

string

required

ID of a bill to which this payment is applied.

string

required

ID of the payment this allocation applies from.

integer

required

Payment amount allocated to this bill, in cents.

Array of Tags

Transaction tags refer to tags associated with this bill payment allocation.

Show Tag properties

string

required

Unique identifier for the tag

string

required

The tag’s key

string

required

The tag’s value

string

Display name for the tag dimension

string

Display name for the tag value

string

required

ID of the tag dimension

string

required

ID of the tag value definition

ISO8601 timestamp

required

When the tag was created

ISO8601 timestamp

required

When the tag was last updated

ISO8601 timestamp

When the tag was deleted

ISO8601 timestamp

When the tag was archived

array of Tag objects

required

Transaction tags refer to tags associated with this bill.

Show Tag properties

string

required

Unique identifier for the tag

string

required

The tag’s key

string

required

The tag’s value

string

Display name for the tag dimension

string

Display name for the tag value

string

required

ID of the tag dimension

string

required

ID of the tag value definition

ISO8601 timestamp

required

When the tag was created

ISO8601 timestamp

required

When the tag was last updated

ISO8601 timestamp

When the tag was deleted

ISO8601 timestamp

When the tag was archived

string

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

object

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

string

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

{
  "data": {
    "id": "590ed436-c2bd-4e39-8047-f913a852f99c",
    "external_id": "bill-payment-1",
    "at": "2024-06-15T00:00:00Z",
    "method": "ACH",
    "amount": 10000,
    "processor": "BANK_TRANSFER",
    "imported_at": "2024-06-15T18:11:57.339076Z",
    "allocations": [
      {
        "id": "8901-abcd-ef23-4567",
        "bill_id": "b745c116-cd28-41a1-b4ea-84a2768b6e14",
        "payment_id": "590ed436-c2bd-4e39-8047-f913a852f99c",
        "amount": 10000,
        "transaction_tags": [
          {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "key": "department",
            "value": "sales",
            "dimension_display_name": "Department",
            "value_display_name": "Sales Team",
            "dimension_id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
            "definition_id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
            "created_at": "2024-02-27T02:16:40.389772Z",
            "updated_at": "2024-02-27T02:16:40.389772Z",
            "deleted_at": null,
            "archived_at": null
          }
        ]
      }
    ],
    "transaction_tags": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "key": "department",
        "value": "sales",
        "dimension_display_name": "Department",
        "value_display_name": "Sales Team",
        "dimension_id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
        "definition_id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
        "created_at": "2024-02-27T02:16:40.389772Z",
        "updated_at": "2024-02-27T02:16:40.389772Z",
        "deleted_at": null,
        "archived_at": null
      }
    ]
  }
}

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Bill payment object

Attributes

​Attributes

Attributes