object Bill
Fields
| Field | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String | Public API ID for this bill. | ||||||||||||||||||||||||||||||
legacy_id | BigInt | Numeric legacy ID for this identifiable; use only where legacy IDs are required. | ||||||||||||||||||||||||||||||
status | String | Current status; use the API status values returned by this field when filtering or updating. | ||||||||||||||||||||||||||||||
customer_name | String | Customer name for this bill. | ||||||||||||||||||||||||||||||
profile_name | String | Profile name for this bill. | ||||||||||||||||||||||||||||||
created_at | ISODateTime | Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted. | ||||||||||||||||||||||||||||||
due_date | ISODateTime | Due date in ISO-8601 date or datetime format, returned in UTC when time is included. | ||||||||||||||||||||||||||||||
amount | Money | Monetary amount as a decimal value in the record currency; not cents. | ||||||||||||||||||||||||||||||
totals | FeeCategoryTotalConnection | Totals for this bill. | ||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
bill_exports | BillExportsConnection | Bill exports for this bill. | ||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
billing_period | BillingPeriod | Billing period for this bill. | ||||||||||||||||||||||||||||||
billing_frequency | String | Billing frequency for this bill. | ||||||||||||||||||||||||||||||
Referenced By
- BillEdge Type
- BillQueryResult Type
- CreateBillOutput Type
- RecalculateBillOutput Type
Example
{
"id": "QmlsbDoxMjM0",
"legacy_id": 1234,
"status": "pending",
"customer_name": "July Fulfillment Fees",
"profile_name": "default",
"created_at": "2026-07-09T15:30:00Z",
"due_date": "2026-07-09T15:30:00Z",
"amount": "19.99",
"totals": [{labor_unit: "HOURS", unit_rate: 19.99, quantity: 2}],
"bill_exports": [{id: "QmlsbEV4cG9ydHM6MTIzNA=="}],
"billing_period": {id: "QmlsbGluZ1BlcmlvZDoxMjM0"},
"billing_frequency": "monthly"
}