GET /billing/history
Retrieves a List of historical freight billing records matching the given request parameters.
Roles that can access this endpoint are Users.
Parameters
name |
description |
type |
default |
type |
request |
read for query parameters to be used as search criteria; use any combination of fields from the billing_history table
For example, /billing/history?is_summary_bill=Y&blnum=12345*&ship_date=>=t-100
would find bills printed on a summary bill having a BOL that starts with '12345' that shipped in
the last 100 days. |
context
|
|
HttpServletRequest
|
includeUsers |
whether to include user detail records with each invoice |
query
|
|
boolean
|
includeCustomer |
whether to include customer details with each invoice |
query
|
|
boolean
|
Result
List
<
RowBillingHistory
>
of type:
application/xml
application/json
a list of RowBilling records for all historical invoices
Additional attributes:
__revenuTypeDescr
the description of the revenue code, found in the revenue_id
field
__rateTypeDescr
the hard coded description of the rate type, found in the rate_type
field
__billTypeDescr
the hard coded description of the bill type, found in the bill_type
field
__paymentMethodDescr
the hard coded description of the payment method, found in the payment_method
field
Child Elements:
RowOtherChargeBill
the other charges associated with the bill; each containing a __name
attribute equal to otherCharges
RowUsers
the entered by user associated with the entered_user_id
field; contains a __name
attribute equal to enteredUser
(included only when the includeUsers
query parameter is true)
RowUsers
the billing user associated with the billing_user_id
field; contains a __name
attribute equal to billingUser
(included only when the includeUsers
query parameter is true)
RowCustomer
the customer associated with the customer_id
field; contains a __name
attribute equal to customer
(included only when the includeCustomer
query parameter is true)
Try It Out
Request