Freight Invoice events
A Freight Invoice is an invoice that is created and managed within Shipwell. Shipwell is the source of truth for a Freight Invoice. Access to the individual events is dependent on whether you are the booking party or service provider on the invoice.
Freight Invoice created
(freight_invoice.sent, freight_invoice.received)
Schema
FreightInvoiceCreatedEventDetails:
title: FreightInvoiceCreatedEventDetails
required:
- id
- invoiceable
- self_link
- resource_type
- invoice_source
type: object
properties:
id:
title: Id
type: string
invoice_number:
title: Invoice Number
type: string
service_provider_name:
title: Service Provider Name
type: string
notes:
title: Notes
type: string
due_date:
title: Due Date
type: string
format: date
documents:
title: Documents
type: array
items:
$ref: '#/components/schemas/FreightInvoiceDocument'
default: []
self_link:
title: Self Link
type: string
resource_type:
title: Resource Type
enum:
- freight_invoice
type: string
invoice_source:
$ref: '#/components/schemas/FreightInvoiceSource'
FreightInvoiceDocument:
title: FreightInvoiceDocument
required:
- self_link
- resource_type
type: object
properties:
self_link:
title: Self Link
maxLength: 65536
minLength: 1
type: string
format: uri
resource_type:
$ref: '#/components/schemas/DocumentType'
DocumentType:
title: DocumentType
enum:
- BOL
- FUEL
- LUMPER
- HOS
- SIGNATURE
- RATE_CONFIRMATION
- CUSTOMER_TENDER
- DELIVERY_RECEIPT
- WEIGHT_CERTIFICATE
- OVERAGES_SHORTAGES_AND_DAMAGES
- 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
type: string
description: Types of documents that are tracked in Shipwell.
FreightInvoiceSource:
title: FreightInvoiceSource
enum:
- EDI_210
- DFM
- SHIPWELL_WEB
- UPLOADED_INVOICE
type: string
description: How was the invoice created?Example
{
"id": "55d0253b-1451-4c87-8c11-62509b5611a2",
"resource_type": "freight_invoice",
"self_link": "/freight/invoices/55d0253b-1451-4c87-8c11-62509b5611a2",
"invoice_number": "INV_12345",
"total_amount": {
"value": "100.00",
"currency": "USD"
},
"due_date": "2022-05-27",
"notes": "Notes on the invoice.",
"invoiceable": {
"id": "92ac80fc-bd31-4176-a02b-4aa4768831cf",
"type": "V2_Shipment",
"reference_number": "ABC123",
"total_amount": {
"value": "100.00",
"currency": "USD"
}
},
"documents": [
{
"self_link": "https://shipwell.com/documents/doc.pdf",
"type": "INVOICE"
},
{
"self_link":" https://shipwell.com/documents/doc.pdf",
"resource_type": "DELIVERY_RECEIPT"
}
],
"invoice_source": "SHIPWELL_WEB"
}Freight Invoice Status Updated
(freight_invoice.sent.status_updated, freight_invoice.received.status_updated)
Schema
FreightInvoiceStatusUpdatedDetails:
title: FreightInvoiceStatusUpdatedDetails
required:
- id
- invoiceable
- old_status
- new_status
- self_link
- resource_type
type: object
properties:
id:
title: Id
type: string
invoiceable:
$ref: '#/components/schemas/FreightInvoiceInvoiceable'
old_status:
title: Old Status
anyOf:
- $ref: '#/components/schemas/FreightInvoiceStatus'
- $ref: '#/components/schemas/FreightInvoiceCarrierStatus'
new_status:
title: New Status
anyOf:
- $ref: '#/components/schemas/FreightInvoiceStatus'
- $ref: '#/components/schemas/FreightInvoiceCarrierStatus'
self_link:
title: Self Link
type: string
resource_type:
title: Resource Type
enum:
- freight_invoice
type: string
FreightInvoiceInvoiceable:
title: FreightInvoiceInvoiceable
required:
- id
type: object
properties:
id:
title: Id
type: string
type:
title: Type
type: string
reference_number:
title: Reference Number
type: string
FreightInvoiceStatus:
title: FreightInvoiceStatus
enum:
- RECEIVED
- PASSED
- EXCEPTION
- APPROVED
- SCHEDULED
- PAID
- VOIDED
- REJECTED
type: string
description: |2-
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.
FreightInvoiceCarrierStatus:
title: FreightInvoiceCarrierStatus
enum:
- REVIEWING
type: string
description: |2-
A service provider will not see if an invoice is in RECEIVED, PASSED, EXCEPTION, or APPROVED.
REVIEWING: the invoice is being reviewed by the booking party.
Example
{
"id": "55d0253b-1451-4c87-8c11-62509b5611a2",
"resource_type": "freight_invoice",
"self_link": "/freight/invoices/55d0253b-1451-4c87-8c11-62509b5611a2",
"invoiceable": {
"id": "92ac80fc-bd31-4176-a02b-4aa4768831cf",
"type": "V2_Shipment",
"reference_number": "ABC123",
},
"old_status": "REVIEWING",
"new_status": "APPROVED"
}