Skip to main content
PATCH
/
v0
/
business
/
{business_id}
/
bills
/
{bill_id}
Update a Bill
curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/bills/{bill_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "number": "<string>",
  "description": "<string>",
  "due_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "line_changes": {
    "create_lines": [
      {
        "description": "<string>",
        "number": "<string>",
        "ledger_id": "<string>",
        "amount": 123,
        "metadata_": {}
      }
    ],
    "delete_lines": [
      "<string>"
    ]
  }
}'
{
  "data": {
    "business_id": "biz_Pk2fNFDd8wj7EFeLWJywc7",
    "vendor_id": "<string>",
    "number": "<string>",
    "description": "<string>",
    "total_amount": 123,
    "total_paid": 123,
    "due_at": "2023-11-07T05:31:56Z",
    "issued_at": "2023-11-07T05:31:56Z",
    "voided_at": "2023-11-07T05:31:56Z",
    "status": "open",
    "metadata_": {},
    "id": "bill_WQMDNUHpBThYSNh4AprDBo",
    "lines": [
      {
        "description": "<string>",
        "number": "<string>",
        "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
        "amount": 123,
        "metadata_": {},
        "id": "bill_line_WQMDNUHpBThYSNh4AprDBo",
        "bill_id": "bill_WQMDNUHpBThYSNh4AprDBo"
      }
    ],
    "payments": [
      {
        "bill_id": "bil_WQMDNUHpBThYSNh4AprDBo",
        "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",
        "payment_id": "blp_WQMDNUHpBThYSNh4AprDBo",
        "datetime": "2021-01-01T00:00:00Z",
        "payment_amount": 123,
        "id": "blp_WQMDNUHpBThYSNh4AprDBo",
        "bill": {}
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id
string<biz_string>
required
bill_id
string<bil_string>
required

Body

application/json
number
string | null

The new number of the bill

description
string | null

The new description of the bill

due_at
string<date-time> | null

The new due date of the bill in ISO-8601 format

issued_at
string<date-time> | null

The new issued date of the bill in ISO-8601 format

status
enum<string> | null

The new status of the bill

Available options:
open,
paid,
voided
line_changes
object | null

The changes to the lines of the bill

Response

Successful Response

data
object
required
I