Get Freight Invoice

SecurityAPIKeyHeader
Request
path Parameters
invoice_id
required
string (Invoice Id)
query Parameters
include
Array of strings (FreightInvoiceIncludeOptions)
Default: []
Items Enum: "processed_total" "total_passed"
Responses
200

Successful Response

Response Schema: application/json
created_at
required
string <date-time> (Created At)

Datetime object was created

updated_at
required
string <date-time> (Updated At)

Datetime object was updated

id
required
string (Id)
custom_data
object (Custom Data)

Additional data associated to the resource

invoice_source
required
string (FreightInvoiceSource)

How is the invoice being created? NOTE: CARRIER_GENERATED option has been deprecated and will be converted to SHIPWELL_WEB.

Enum: "CARRIER_GENERATED" "EDI_210" "DFM" "SHIPWELL_WEB" "UPLOADED_INVOICE"
Array of objects (Charge Line Items)

List of charges being invoiced

required
object (MoneyRequest)
currency
required
string (Currency) = 3 characters

3-character ISO-4217 currency code

invoiceable
required
any (Invoiceable)

What is being invoiced

service_provider_name
required
string (Service Provider Name)

Name of Service Provider at time of Invoice Creation

Array of objects (Stops)

List of locations relevant to the Invoice

Array of objects (Product Line Items)

List of items being processed by provided service

object (Remit To)

Entity to which payment should be made

object (Bill To)

Entity from which payment should be requested

external_id
string (External Id)

Unique system identifier for the invoice used by a service provider in their own external system

invoice_number
string (Invoice Number)

Reference number for the invoice used by a service provider in their own external system

due_date
string <date> (Due Date)

Date by which the payment is due

notes
string (Notes)

Any notes on the invoice

invoice_date
string <date> (Invoice Date)

Date this invoice was created on. If not provided, it will default to the created_at date

generated_by
string (GeneratedBy)

Read-only field that provides which party generated the Invoice. If this field is null, we were unable to determine who this Invoice was generated by

Enum: "SERVICE_PROVIDER" "BOOKING_PARTY"
Array of Documents (objects) or Array of Documents (objects) (Documents)
Default: []

Documents attached to the invoice

FreightInvoiceStatus (string) or FreightInvoiceCarrierStatus (string) or FreightInvoicePendingStatus (string) (Status)
Default: "RECEIVED"

Current status of the invoice

Array of objects (Sub Statuses)

Sub statuses of the invoice

object (Processed Total)

[Deprecated in favor of total_passed] Sum of totals on all invoices with same invoiceable and in PASSED/APPROVED/SCHEDULED/PAID status

object (Total Passed)

Sum of totals on all invoices with same invoiceable and in PASSED/APPROVED/SCHEDULED/PAID status

400

Validation Error

get/freight-invoices/{invoice_id}
Request samples 
Response samples 
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "custom_data": { },
  • "invoice_source": "CARRIER_GENERATED",
  • "charge_line_items": [
    ],
  • "total_amount": {
    },
  • "currency": "USD",
  • "invoiceable": null,
  • "service_provider_name": "string",
  • "stops": [
    ],
  • "product_line_items": [
    ],
  • "remit_to": {
    },
  • "bill_to": {
    },
  • "external_id": "string",
  • "invoice_number": "string",
  • "due_date": "2019-08-24",
  • "notes": "string",
  • "invoice_date": "2019-08-24",
  • "generated_by": "SERVICE_PROVIDER",
  • "documents": [ ],
  • "status": "RECEIVED",
  • "sub_statuses": [
    ],
  • "processed_total": {
    },
  • "total_passed": {
    }
}
Copyright © Shipwell 2024. All right reserved.