object BillingCharge

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

confirmation_dateDateTime

Confirmation date in ISO-8601 format.

charge_labelString

Configured label for this charge.

categoryString

Billing category for this charge.

quantityInt

Number of billable units.

rate_amountDecimal

Rate per billable unit.

amountDecimal

Total charge amount.

customer_account_idString

Public API Account ID for the billed customer.

customer_nameString

Display name of the billed customer.

warehouse_idString

Public API Warehouse ID associated with the charge.

warehouse_fromString

Display name of the warehouse associated with the charge.

statusBillingChargeStatus

Current invoice status of the charge.

transaction_typeBillingChargeTransactionType

Billing transaction type.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "confirmation_date": "2026-07-09T15:30:00Z",
  "charge_label": "receiving_fee",
  "category": "inbound",
  "quantity": 2,
  "rate_amount": 19.99,
  "amount": 39.98,
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "customer_name": "Acme Brand",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "warehouse_from": "Primary Warehouse",
  "status": "READY_TO_INVOICE",
  "transaction_type": "INBOUND"
}