List Freight Invoice Documents

SecurityAPIKeyHeader
Request
path Parameters
invoice_id
required
string (Invoice Id)
Responses
200

Successful Response

Response Schema: application/json
Array
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)
document_type
string (DocumentType)
Default: "OTHER"

Type of document being uploaded

Enum: "BOL" "FUEL" "LUMPER" "HOS" "SIGNATURE" "RATE_CONFIRMATION" "CUSTOMER_TENDER" "DELIVERY_RECEIPT" "WEIGHT_CERTIFICATE" "OVERAGES_SHORTAGES_AND_DAMAGES" "RENDITION_INVOICE_PACKET" "INVENTORY_RELEASE" "INVOICE" "INSURANCE" "SHIPPING_LABEL" "CUSTOMS_PAPERWORK" "PACKING_SLIPS" "CARRIER_INVOICE_OR_BILLING_STATEMENT" "CUSTOMER_INVOICE" "DELIVERY_ORDER" "FACTOR_INVOICE_OR_BILLING_STATEMENT" "LETTER_OF_ASSIGNMENT" "NMFC_CERTIFICATE" "NOTICE_OF_ASSIGNMENT" "NOTICE_OF_RELEASE" "PACKING_SLIP" "ADVANCE_REQUEST" "DRIVER_FORM" "TOLL_RECEIPT" "EXIT_PASS" "WASH_RECEIPT" "DETENTION_APPROVAL" "FINE" "W9" "AUTHORITY" "CLAIM" "COMCHECK" "MASTER_BILL_OF_LADING" "HOUSE_BILL_OF_LADING" "WAYBILL" "COMMERCIAL_INVOICE" "CERTIFICATE_OF_ORIGIN" "INSPECTION_CERTIFICATE" "WEIGHT_TICKET_UNLOADED" "PALLET_RECEIPT" "HOUSE_AIRWAY_BILL" "MASTER_AIRWAY_BILL" "CUSTOMS_CLEARANCE_REQUEST" "CUSTOMS_ENTRY_SUMMARY" "OTHER" "LUMPER_CERTIFICATE" "LETTER_OF_AUTHORIZATION"
description
string (Description)

Description for the document

invoiceable_document_id
string (Invoiceable Document Id)

ID for the document if copied from other internal system, ie backend-core shipment documents.

record_of_truth
boolean (Record Of Truth)
Default: false

Indicator for if this document is a reflection of data on the Freight Invoice.

public_url
required
string <uri> (Public Url) [ 1 .. 65536 ] characters

Pre-authenticated url to retrieve the file

400

Validation Error

get/freight-invoices/{invoice_id}/documents
Request samples 
Response samples 
application/json
[
  • {
    }
]
Copyright © Shipwell 2024. All right reserved.