Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
bills
/
bill-payments
/
{paymentId}
/
update
Update bill payment
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/bill-payments/{paymentId}/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "at": "2023-11-07T05:31:56Z",
  "amount": 123,
  "method": "CASH",
  "processor": "<string>",
  "payment_clearing_account_identifier": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "bill_payment_allocations": [
    {
      "amount": 123,
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_external_id": "<string>",
      "tags": [
        {
          "key": "department",
          "value": "sales",
          "dimension_display_name": "Department",
          "value_display_name": "Sales Department"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt

Use this file to discover all available pages before exploring further.

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 the payment belongs to.

ā€‹
paymentId
string<uuid>
required

The UUID of the payment to update.

Body

application/json
ā€‹
external_id
string | null

External ID for the payment.

ā€‹
at
string<date-time>

When the payment was made.

ā€‹
amount
integer<int64>

Payment amount in cents.

ā€‹
method
enum<string>

Method used for payment.

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
CREDIT_BALANCE,
OTHER
ā€‹
processor
string | null

Payment processor used.

ā€‹
payment_clearing_account_identifier
Account ID Ā· object

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

ā€‹
bill_payment_allocations
object[]

Updated payment allocations across bills.

ā€‹
tags
object[]
ā€‹
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 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 payment. Can be used to filter when listing bill payments.

Response

200 - application/json

Payment updated successfully.

ā€‹
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<int64>

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 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 payment. Can be used to filter when listing bill payments.