List Freight Invoices

SecurityAPIKeyHeader
Request
query Parameters
include
Array of strings (FreightInvoiceIncludeOptions)
Default: []
Items Enum: "processed_total" "total_passed"
exclude_document_urls
boolean (Exclude Document Urls)
Default: false
exclude_related_entities
Array of strings (FreightInvoiceExcludeRelatedEntitiesOptions)
Default: []
Items Enum: "stops" "charge_line_items" "product_line_items" "bill_to" "sub_statuses"
invoiceable_shipwell_custom_data_id
string (Invoiceable Shipwell Custom Data Id)
invoiceable_shipwell_custom_data_value
string (Invoiceable Shipwell Custom Data Value)
stops__company_name__contains
Array of strings (Stops Company Name Contains)
stops__company_name__icontains
Array of strings (Stops Company Name Icontains)
service_provider_name__contains
string (Service Provider Name Contains)
service_provider_name__icontains
string (Service Provider Name Icontains)
search
string (Search)
order_by
string (Order By)
invoiceable_id
string (Invoiceable Id)
invoiceable_id__in
string (Invoiceable Id In)
invoiceable_mode
string (Invoiceable Mode)
invoiceable_mode__in
string (Invoiceable Mode In)
status
string (FreightInvoiceStatus)

RECEIVED: default status for all new freight invoices. PASSED: invoice has gone through validation process and succeeded based on thresholds. EXCEPTION: invoice failed validation based on thresholds. See exception sub-statuses field for details. APPROVED: invoice has been accepted by booking party with intent of payment. SCHEDULED: invoice is in process of payment, likely via 3rd-party. PAID: booking party has sent payment for the invoice. VOIDED: invoice has been cancelled by service provider. REJECTED: invoice has been rejected by booking party. DISPUTED: invoice is being disputed by booking party. RESOLVED: disputed invoice is resolved either by booking party or by service provider.

Enum: "RECEIVED" "PASSED" "EXCEPTION" "APPROVED" "SCHEDULED" "PAID" "VOIDED" "REJECTED" "DISPUTED" "RESOLVED"
status__in
string (Status In)
status__not_in
string (Status Not In)
invoiceable_reference_number
string (Invoiceable Reference Number)
invoice_source
string (FreightInvoiceSource)

An enumeration.

Enum: "CARRIER_GENERATED" "EDI_210" "DFM" "SHIPWELL_WEB" "UPLOADED_INVOICE"
invoice_source__in
string (Invoice Source In)
service_provider_name
string (Service Provider Name)
invoice_number
string (Invoice Number)
created_at__lt
string <date-time> (Created At Lt)
created_at
string <date-time> (Created At)
updated_at
string <date-time> (Updated At)
total_amount
string <decimal> (Total Amount)
due_date
string <date> (Due Date)
due_date__lt
string <date> (Due Date Lt)
due_date__lte
string <date> (Due Date Lte)
due_date__gt
string <date> (Due Date Gt)
due_date__gte
string <date> (Due Date Gte)
invoice_date
string <date> (Invoice Date)
invoice_date__lt
string <date> (Invoice Date Lt)
invoice_date__lte
string <date> (Invoice Date Lte)
invoice_date__gt
string <date> (Invoice Date Gt)
invoice_date__gte
string <date> (Invoice Date Gte)
role
string (RoleType)

An enumeration.

Enum: "SERVICE_PROVIDER" "BOOKING_PARTY"
remit_to__name
string (Remit To Name)
stops__address
string (Stops Address)
stops__address__contains
string (Stops Address Contains)
stops__address__icontains
string (Stops Address Icontains)
stops__company_name
string (Stops Company Name)
stops__company_name__in
string (Stops Company Name In)
sub_statuses__sub_status
string (FreightInvoiceSubStatusType)

Not delivered: This represents an invoice received for a shipment leg where it has not been delivered.

Wrong party: This represents any invoice that during First Pass Match has been identified as a party requesting payment that does not appear to be a party warranting payment for a shipment. For example, a carrier takes the original shipment and subs it out to another carrier but the original carrier is requesting payment.

Wrong amount: This represents any invoice that during First Pass Match has been: 1) identified to be the wrong amount per the agreed upon financials; and 2) the difference is outside of customer determined thresholds (above or below).

Already paid: This represents any invoice that during First Pass Match has been identified as the shipment leg for the party already scheduled to be paid or paid.

Missing POD: {DEPRECATED IN FAVOR OF: [MISSING_DOC]} This represents any invoice that during First Pass Match has been identified as the shipment leg does not have satisfactory proof of delivery and under Customer Threshold it has the requirement of a proof of delivery present. [For initial effort here we plan on allowing for parties to mark whether a shipment leg has satisfactory Proof of Delivery although in the future we plan on allowing for an automated review to identify if a Proof of Delivery has been provided].

Missing Doc: This represents any invoice that during First Pass Match has been identified as missing one or more documents of the type that is required by the Customer Thresholds for the booking party. Multiple instances of this exception type can exist on a shipment, and the description field will clarify what document type is missing

Not matched: This represents any invoice received but is not matched to a shipment leg within Shipwell.

No Shipment Financials: This occurs when the shipment does not have any charge line items or a total to compare financials against.

Other: This represents other exceptions that may arise that are uncertain at this time.

Enum: "NOT_DELIVERED" "WRONG_PARTY" "WRONG_AMOUNT" "ALREADY_PAID" "MISSING_POD" "NOT_MATCHED" "MISSING_DOC" "NO_SHIPMENT_FINANCIALS" "OTHER"
sub_statuses__sub_status__in
string (Sub Statuses Sub Status In)
page
integer (Page) >= 1
Default: 1
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Responses
200

Successful Response

Response Headers
Link
string

| Corresponds to the Link specification. Only 1 parameter for each link is valid - rel. Within rel, only a few values are valid:

  • rel="next" - If included, there is a next page of results accessed via this url. Will not be included in the response of the last page.
  • rel="prev" - If included, there is a previous page of results access via this url. Will not be included in the response of the first page.
  • rel="first" - A link to access the first page of results, always included
  • rel="last" - If included, a link to access the last page of results

So a first page of results might have a Link header like:

<https://api.shipwell.com/some/path?page=2>; rel="next", <https://api.shipwell.com/some/path?page=1>; rel="first" <https://api.shipwell.com/some/path?page=20>; rel="last"

An intermediary page of results might have a Link header like:

<https://api.shipwell.com/some/path?before=01GK55HVSR279AH0TRWG6FNNJJ>; rel="prev", <https://api.shipwell.com/some/path?before=01GK55HNXR73T4TFBZ79670AXP>; rel="next", <https://api.shipwell.com/some/path?after=01GK55K2WSGEJCQ4D26S5APRHQ>; rel="first" <https://api.shipwell.com/some/path?before=01GK55KAGHB5QYKPYGDB0H2KRC>; rel="last"
Response Schema: application/json
required
Array of objects (Data)
count
required
integer (Count)

Number of the items within the 'data' array.

total_count
integer (Total Count)

Number of items in the entire result set. Value is always >= count. Inclusion depends on the underlying result set.

required
object (PaginationLinks)
400

Validation Error

get/freight-invoices
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "count": 0,
  • "total_count": 0,
  • "links": {}
}
Copyright © Shipwell 2024. All right reserved.