Skip to main content
GET
Billing-queue list (Company.getPosted)

Authorizations

Authorization
string
header
required

Company API key from the developer platform. Header: Authorization: Bearer cw_live_…. Key must include customers:read and/or customers:write.

Query Parameters

q
string
billingQueueStatus
enum<string>
Available options:
POSTED,
NEEDS_REVIEW,
ON_HOLD,
VOIDED
status
string
customers
string
fromDate
string
toDate
string
salesDueStartDate
string
salesDueEndDate
string
deliveryMethod
string
deliveryStatus
string
salesType
string
accountingStatus
string
salesInvoiceType
string
salesOrderType
string
billingGroup
string
paymentPolicies
string
serviceType
string
haulerIds
string
labelIds
string
paymentMethodOnFile
string
isFailedCharges
string
sort
string

JSON object string, e.g. {"number":"desc"}

pageNo
integer
Required range: x >= 1
limit
integer

Results per page (10-100; the upstream billing queue rejects under 10).

Required range: 10 <= x <= 100
expand
string

Response

200 - application/json
data
object[]
required
page
number
required
limit
number
required
total
number
required