Freight Invoice All V1 Ep
POST/v1/freight/invoice/all
Get All Freight Invoices V1 Endpoint
Retrieves invoice data and download links for the physical invoices. Responses limited to 5,000 invoices.
Request
order_numbers: list[int] | None = None
List of order numbers to filter invoices by. If provided, the endpoint will return only invoices associated with these order numbers.
order_ids: list[str] | None = None
List of internal order IDs to filter invoices by. If provided, the endpoint will return only invoices associated with these order IDs.
invoice_numbers: list[str] | None = None
List of invoice numbers to filter by. If provided, the endpoint will return only invoices with these numbers.
status: InvoiceStaticStatus | None = InvoiceStaticStatus.SENT
Invoice status to filter by. By default, returns only sent invoices.
Show Supported Status Values
open
Invoice is ready to send but the send date is in the future.
sent
Invoice has been sent to the recipient.
blocked
Invoice is passed the send date and is blocked by an issue.
hold
Invoice is on hold and cannot be sent.
counterparty_name: str | None = None
Name of the counterparty to filter invoices by.
If provided, the endpoint will return only invoices associated with this counterparty.
This will be the carrier or the customer.
counterparty_id: str | None = None
ID of the counterparty to filter invoices by.
If provided, the endpoint will return only invoices associated with this counterparty.
This will be the carrier or the customer.
book_type: RateBookType = RateBookType.revenue
The type of rate book to filter by. Default is revenue.
Revenue is used to retrieve invoices sent to customers
Show Supported Book Types
revenue
Revenue-based rate books. Typically used for customer invoices.
cost
Cost-based rate books. Typically used for carrier invoices.
as_of: datetime | None = None
Filter invoices as of this date. Filters on the intended send date of the invoice.
updated_as_of: datetime | None = None
Filter invoices last updated on or after this date.
between: DateWindow | None = None
Date range to filter invoices. If provided, returns invoices within this date window.
Filters on the intended send date of the invoice.
sent_between: DateWindow | None = None
Datetime range to filter invoices. If provided, returns invoices within this date window.
Filters on the datetime the invoice was sent.
Response
Returns a list of InvoiceRow objects with the following fields:
invoice_number: str
Unique identifier for the invoice.
sent_date: datetime | None
Date when the invoice was sent.
when_to_send_date: datetime | None
Scheduled date for sending the invoice.
E.g. If invoices are billed monthly this will be a month from the creation of the invoice.
created_on: datetime | None
Date when the invoice was created.
type: InvoiceType
Type of the invoice.
Show Invoice Types
original
Standard invoice.
credit
Credit invoice.
rebill
Rebilled invoice.
status: InvoiceStaticStatus | None
Current status of the invoice.
transactions: list[FreightTransactionRow]
List of freight transactions included in this invoice.
note: str | None
Additional notes attached to the invoice.
bill_to: BillTo | None
Billing address information for the invoice recipient.
Show Child Attributes
name: str | None = None
Name on the billing address.
address: str | None = None
Street address for billing.
city: str | None = None
City for billing address.
state: str | None = None
State for billing address.
postal_code: str | None = None
Postal code for billing address.
download_url: str | None
URL to download the invoice PDF. Only available for sent invoices.
base_amount: float
Base amount of the invoice (calculated field).
base_distance: float
Base distance covered for this invoice (calculated field).
distance_uom: str
Unit of measure for distance (calculated field).
accessorial_amount: float
Total amount of accessorial charges (calculated field).
surcharge_amount: float
Total amount of surcharges (calculated field).
total_amount: float
Total invoice amount (calculated field).
Responses
- 200
- 422
Successful Response
- application/json
- Example (from schema)
[
{
"invoice_number": "string",
"sent_date": "2025-12-17T21:49:50.704Z",
"when_to_send_date": "2025-12-17T21:49:50.704Z",
"created_on": "2025-12-17T21:49:50.704Z",
"due_date": "2025-12-17T21:49:50.704Z",
"updated_on": "2025-12-17T21:49:50.704Z",
"type": "credit",
"status": "open",
"errors": [
{
"type": "No Freight Rate",
"message": "string"
},
{
"type": "Email Failed",
"message": "string"
}
],
"transactions": [
{
"order_id": "string",
"order_number": 0,
"po": "string",
"date": "2025-12-17T21:49:50.705Z",
"invoice_group_id": "string",
"invoice_number": "string",
"details": [
{
"timezone_data": {},
"id": "string",
"counterparty": "string",
"counterparty_id": "string",
"product_group": "Gasoline",
"product_name": "string",
"product_id": "string",
"type": "Base Freight",
"subtype": "string",
"manual": true,
"has_dependency": true,
"origin_name": "string",
"origin_id": "string",
"origin_name_override": "string",
"origin_id_override": "string",
"origin_name_original": "string",
"origin_id_original": "string",
"destination_name": "string",
"destination_id": "string",
"destination_name_override": "string",
"destination_id_override": "string",
"destination_name_original": "string",
"destination_id_original": "string",
"requires_approval_reason_code": true,
"is_approved": true,
"approved_by": "string",
"approved_date": "2025-12-17T21:49:50.705Z",
"approval_reason_code": "string",
"invoice_id": "string",
"invoice_group_id": "string",
"amount_original": 0,
"rate_original": 0,
"product_id_original": "string",
"product_name_original": "string",
"product_group_original": "Gasoline",
"subtype_original": "string",
"uom_original": "string",
"total_original": 0,
"amount_override": 0,
"rate_override": 0,
"product_id_override": "string",
"product_name_override": "string",
"product_group_override": "Gasoline",
"subtype_override": "string",
"uom_override": "string",
"total_override": 0,
"override_by": "string",
"override_date": "2025-12-17T21:49:50.705Z",
"rate": 0,
"amount": 0,
"total": 0,
"uom": "string",
"date": "2025-12-17T21:49:50.705Z",
"status": "estimated",
"error": {
"type": "No Freight Rate",
"message": "string"
},
"legs": [
{
"origin": "string",
"origin_id": "string",
"destination": "string",
"destination_id": "string",
"distance": 0
}
],
"credit_rebill_metadata": {
"impact_type": "impacted",
"delta_amount": 0,
"delta_base_total": 0,
"delta_surcharge_total": 0,
"delta_accessorial_total": 0,
"delta_total": 0
},
"net_volume": 0,
"gross_volume": 0,
"bol_number": "string",
"bol_number_override": "string",
"bol_number_original": "string",
"bol_date": "2025-12-17T21:49:50.705Z",
"delivery_date": "2025-12-17T21:49:50.705Z",
"linked_sp_info": {
"special_pay": "string",
"order_number": "string",
"created_by": "string",
"created_on": "2025-12-17T21:49:50.705Z",
"approved_by": "string",
"approved_on": "2025-12-17T21:49:50.705Z",
"status": "string",
"note": "string"
},
"book_type": "Cost",
"can_edit": true,
"has_override": true
}
],
"carrier_id": "string",
"carrier_name": "string",
"customer_id": "string",
"customer_name": "string",
"book_type": "Cost",
"origins": [
"string"
],
"destinations": [
"string"
],
"bol_numbers": [
"string"
],
"status": "estimated",
"error": {
"type": "No Freight Rate",
"message": "string"
},
"credit_rebill_metadata": {
"impact_type": "impacted",
"delta_amount": 0,
"delta_base_total": 0,
"delta_surcharge_total": 0,
"delta_accessorial_total": 0,
"delta_total": 0
},
"parent_transaction_id": "string",
"new_version_available": false,
"new_version_total": 0,
"is_multi_customer": false,
"tractor_number": "string",
"trailer_number": "string",
"product_groups": [
"Gasoline",
"string"
],
"distance": 0,
"distance_uom": "string",
"volume": 0,
"net_volume": 0,
"gross_volume": 0,
"volume_uom": "string",
"total": 0,
"accessorial_total": 0,
"surcharge_total": 0,
"base_total": 0
}
],
"note": "string",
"bill_to": {
"name": "string",
"address": "string",
"city": "string",
"state": "string",
"postal_code": "string"
},
"exported": false,
"exported_at": "2025-12-17T21:49:50.705Z",
"base_amount": 0,
"base_distance": 0,
"distance_uom": "string",
"accessorial_amount": 0,
"surcharge_amount": 0,
"total_amount": 0
}
]
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}