Retrieve a Bill

Retrieve a Bill

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/bills/{bill_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "business_id": "<string>",
    "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",
    "status": "open",
    "id": "<string>",
    "voided_at": "2023-11-07T05:31:56Z",
    "metadata_": {},
    "lines": [
      {
        "description": "<string>",
        "number": "<string>",
        "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
        "amount": 123,
        "id": "<string>",
        "bill_id": "<string>",
        "metadata_": {}
      }
    ],
    "payments": [
      {
        "bill_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "bill": "<unknown>"
      }
    ]
  }
}

GET

business

{business_id}

bills

{bill_id}

Retrieve a Bill

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/bills/{bill_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "business_id": "<string>",
    "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",
    "status": "open",
    "id": "<string>",
    "voided_at": "2023-11-07T05:31:56Z",
    "metadata_": {},
    "lines": [
      {
        "description": "<string>",
        "number": "<string>",
        "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
        "amount": 123,
        "id": "<string>",
        "bill_id": "<string>",
        "metadata_": {}
      }
    ],
    "payments": [
      {
        "bill_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "bill": "<unknown>"
      }
    ]
  }
}

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

Response

Successful Response

data

BillPublic · object

required

Show child attributes

data.business_id

string<biz_string>

required

The ID of the Business that the bill is associated with

data.vendor_id

string<ven_string>

required

The ID of the Vendor that the bill is associated with

data.number

string

required

The id or number of the bill

Maximum string length: 255

data.description

string

required

The description of the bill

Maximum string length: 512

data.total_amount

number

required

The amount of the bill

data.total_paid

number

required

The amount of the bill that has been paid

data.due_at

string<date-time>

required

The due date of the bill

data.issued_at

string<date-time>

required

The date the bill was sent

data.status

enum<string>

required

The status of the bill

Available options:

open,

paid,

voided

data.id

string<bil_string>

required

The ID of the bill

data.voided_at

string<date-time> | null

The date the bill was voided

data.metadata_

Metadata · object

data.lines

BillLinePublic · object[] | null

The lines of the bill

Show child attributes

data.lines.description

string

required

The description of the line item

Maximum string length: 512

data.lines.number

string

required

The id or number of the bill line item

Maximum string length: 255

data.lines.ledger_id

string<ldg_string> | null

required

The ID of the ledger that the line item is associated with

Example:

"ldg_WQMDNUHpBThYSNh4AprDBo"

data.lines.amount

number

required

The amount of the line item

data.lines.id

string<bln_string>

required

The ID of the bill line

data.lines.bill_id

string<bil_string>

required

The ID of the bill that the line item is associated with

data.lines.metadata_

Metadata · object

data.payments

BillPaymentPublic · object[] | null

The payments associated with the bill

Show child attributes

data.payments.bill_id

string<bil_string>

required

The ID of the bill that the payment is associated with

data.payments.transaction_id

string<txn_string>

required

The ID of the transaction that the payment is associated with

data.payments.payment_id

string

required

The external identifier of the payment

Maximum string length: 255

data.payments.datetime

string<date-time>

required

The date and time the payment was made

data.payments.payment_amount

number

required

The amount of the payment

data.payments.id

string<blp_string>

required

The ID of the bill payment

data.payments.bill

any | null

The bill that the payment is associated with

Create Bills Delete a Bill

⌘I

API Overview

Authentication

Business

Journal Entry

Ledger

Reports

Transaction

Invoice

Bill

Request

Document

Webhooks

Authorizations

Path Parameters

Response