POST
/
v1
/
businesses
/
{businessId}
/
bills
/
{billId}
/
update
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/{billId}/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "<string>",
  "received_at": "2023-11-07T05:31:56Z",
  "due_at": "2023-11-07T05:31:56Z",
  "bill_terms": "DUE_ON_RECEIPT",
  "bill_number": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_external_id": "<string>",
  "line_items": [
    {
      "external_id": "<string>",
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "product_name": "<string>",
      "unit_price": 123,
      "quantity": 1,
      "discount_amount": 123,
      "sales_taxes": [
        {
          "amount": 123,
          "tax_rate": 123,
          "tax_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tax_rate_name": "<string>"
        }
      ]
    }
  ],
  "payments": [
    {
      "external_id": "<string>",
      "method": "CASH",
      "amount": 123,
      "processor": "<string>"
    }
  ],
  "additional_sales_taxes": [
    {
      "amount": 123,
      "tax_rate": 123,
      "tax_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tax_rate_name": "<string>"
    }
  ],
  "status": "RECEIVED"
}'
{
  "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",
  "bill_number": "<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"
      },
      "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
    }
  ],
  "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>",
        "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"
              }
            ]
          }
        ],
        "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"
          }
        ]
      },
      "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"
        }
      ]
    }
  ],
  "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>",
    "notes": "<string>",
    "status": "ACTIVE"
  },
  "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"
    }
  ]
}

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 the bill belongs to

​
billId
string
required

The UUID of the bill to update

Body

application/json
​
external_id
string | null

External ID for the bill within your platform.

​
received_at
string

When the bill was received.

​
due_at
string

When the bill is due. Cannot be specified along with bill_terms.

​
bill_terms
enum<string>

Payment terms for the bill. Cannot be specified along with due_at.

Available options:
DUE_ON_RECEIPT,
NET_10,
NET_15,
NET_30,
NET_60
​
bill_number
string | null

Number for the bill for display to end-users.

​
vendor_id
string

ID of the vendor associated with the bill.

​
vendor_external_id
string

External ID of the vendor associated with the bill.

​
line_items
object[]

Updated line items for the bill.

​
payments
object[]

Updated payments for the bill.

​
additional_sales_taxes
object[]

Updated additional sales tax line items.

​
status
enum<string>

Updated status of the bill.

Available options:
RECEIVED,
PARTIALLY_PAID,
PAID,
VOIDED

Response

200 - application/json
Bill updated successfully
​
id
string

Unique identifier for the bill.

​
business_id
string

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

When the bill was received.

​
due_at
string | null

When the bill is due.

​
paid_at
string | null

When the bill was paid.

​
voided_at
string | null

When the bill was voided.

​
bill_number
string | null

Number for the bill for display.

​
line_items
object[]

Line items making up the bill

​
additional_sales_taxes
object[]

Additional sales tax line items

​
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

​
imported_at
string

When the bill was imported

​
updated_at
string

When the bill was last updated

​
vendor
object

The vendor associated with this bill

​
transaction_tags
object[]

Tags on the transactions

Create billVoid bill