get
https://pluto.cargobase.com/api/1/invoices/
The Invoice Detail end-point can be used to retrieve all specifics of an invoice. Please be aware; some shipments do have multiple invoices.
Request URI
GET https://pluto.cargobase.com/api/1/invoices/`INVOICE_REFERENCE`
Authorization: Token your_token_hereStatus codes
| Status | Description | Resolution |
|---|---|---|
| 200 | OK | -- |
| 403 | Forbidden | check Authentication token, or status of the Invoice |
| 404 | Not Found | Check the Invoice reference |
Request Response
Invoice Response categories
The response is divided into 4 possible categories for shippers and providers, these are:
| Category | Definition |
|---|---|
| organization | Details related to the organization, such as WBS Codes or Cost Centers |
| service | Details related to the service, such as freight mode, incoterms or clearance instructions |
| schedule | Details related to pickup & delivery timing and locations |
| financial | Data related to the invoice itself and the quoted amount |
| attachments | List of files related to the invoice, such as invoice PDFs or supporting documents |
Invoice > attachments
List of attachments associated with the invoice.
| Key | Value | Description |
|---|---|---|
| id | INTEGER | Internal identifier of the attachment |
| name | STRING | File name of the attachment |
| reference_number | STRING | Reference number for the attachment |
| file_extension | STRING | File extension (e.g., pdf, jpg) |
| url | STRING | Path to the file location, typically under /media/ |
Invoice > organization
Details related to the organization, such as WBS Codes or Cost Centers.
| Key | Value | Description |
|---|---|---|
| shipment_id | STRING | The request ID |
| invoice_reference | STRING | The unique identifier of the invoice, generated by Cargobase |
| provider_invoice_number | STRING | Identifier of the invoie, submitted by the provider |
| invoice_status | STRING | Current status of the invoice, see list for potentiatl status below |
| invoice_submit_date | STRING | Date the invoice was submitted |
| approved_by | STRING | Name of the invoice approver |
| approved_by_email | STRING | Email of the invoice approver |
| shipment_title | STRING | Title of the shipment |
| invoice_location | STRING | Organizational unit in Cargobase to which the invoice is assigned |
| cost_center | STRING | Value entered in the cost_center field, the shipper might use a custom label for this field and therefore not recognise the term cost_center |
| custom_field1 | STRING | Value entered in the custom_field1 field, the shipper might use a custom label for this field and therefore not recognise the term custom_field |
| reason_code | STRING | Value entered in the reason_code field, the shipper might use a custom label for this field and therefore not recognise the term reason_code |
| billed_from_name | STRING | Addressee of the invoicer |
| billed_from_address | OBJECT | Object containing address details of the sender |
| billed_to_name | STRING | Addressee of the recipient |
| billed_to_address | OBJECT | Object containing address details of the recipient |
| total_invoices | INTEGER | Number of invoices associated with the shipment |
| good_items | OBJECT | Details related to the packing list |
invoice_status options
| Status | Definition |
|---|---|
| Unsubmitted | A draft invoice, visible to Providers only |
| Awaiting Audit | Submitted by the provider and now awaiting approval/declination by the shipper |
| Approved | An invoice that was approved and forwarder to the correct payment provider |
| Declined | An invoice that was declined and will need to be resubmitted |
| Canceled | An invoice that was canceled by the provider before receiving approval |
| Removed | An invoice that was removed from contention by the provider, and will not be submitted for approval or payment |
| Auto removed | An invoie that was automatically removed by the provider and will not be submitted for approval or payment |
Invoice > organization > good_items
Details related to the packing list. The good_items object contains limited information related to the actual packing list. Details regarding the 'requested' packing list, can be recovered from the request detail end-point.
| Key | Value | Description |
|---|---|---|
| requested_total_weight | FLOAT | Value of the total weight of the packing list, as defined by the shipper during the quote request |
| requested_total_weight_uom | STRING | Unit of Measurement for the total requested weight (either KG or LBS) |
| actual_total_weight | FLOAT | Value of the total weight of the packing list, as moved and defined by the provider, e.g. the weight the invoice is based on |
| actual_total_weight_uom | STRING | Unit of Measurement for the total actual weight (either KG or LBS) |
| request_units | INTEGER | Number of individual items requested to move |
| actual_units | INTEGER | Number of individual items actually moved |
| actual_good_items | OBJECT | Object with details on individual handling units. |
Invoice > organization > good_items > actual_good_items
Details related to the packing list. The good_items object contains limited information related to the actual packing list. Details regarding the 'requested' packing list, can be recovered from the request detail end-point.
| Key | Value | Description |
|---|---|---|
| handling_unit | STRING | Name or identifier of the handling unit (e.g. "box" or "pallet") |
| length | FLOAT | Number relating to the dimension of the longest horizontal axis |
| height | FLOAT | Number relating to the dimension of the vertical axis |
| width | FLOAT | Numebr relating to the dimension of the shortest horizontal axis |
| m_unit | STRING | Related to dimensional unit of measurement, either CM or INCH |
| weight | FLOAT | Number related to the weight of an individual item |
| w_unit | STRING | Unit of Measurement for the total requested weight (either KG or LBS) |
| total_cbm | FLOAT | Number related to the cumuliative cubic meters of handling units of this type |
| unit_cbm | FLOAT | Number related to the cubic meters of an individual handling unit of this type |
| stackable | BOOLEAN | Boolean to indicate if you can put one of this on top of the other |
| hazardous | BOOLEAN | Booelan to indicate if the contents are considered hazardous (Subjective ranking) |
| is_dangerous_good | BOOLEAN | Boolean to indicate if contents are classified in one of 9 dangerous goods categories (Objective classification) |
| dangerous_good_value | INTEGER | Number relating to the Dangerous goods category (1 through 9) |
| crating_required | BOOLEAN | Boolean to indicate if crating of the item is requested |
| crating_required_by_date | STRING | End date by when the crating should be completed before pickup, date in YYYY-MM-DD |
| other_instructions | STRING | Text from a custom instruction field |
| additional_information | STRING | Text from a general 'additional information' textarea, can include line break tags <BR> |
| container_type | STRING | Text refering to the type of container (see Shipment or request details for detailed description) |
| good_customs_information | OBJECT | Object related to manually added customs details (see Shipment or request details for detailed description) |
Invoice > service
Basic information related to the service, such as requested freight mode and incoterms.
| Key | Value | Description |
|---|---|---|
| incoterm | STRING | The requested incoterm |
| freight_mode | STRING | The freight mode of the shipment - see freight mode options below |
| provider | STRING | Name of the awarded party |
| quote_id | STRING | Reference number of the selected quote |
| provider_reference | STRING | Optional reference to the provider |
freight_mode values
- Air charter
- Next flight out (NFO)
- Ocean freight
- Rail freight
- Regular air freight
- Road freight
- Parcel
- On board courier (OBC)
- Custom values, specific to each shipper.
Invoice > schedule
Details related to pickup & delivery timing and locations.
| Key | Value | Description |
|---|---|---|
| pickup_airport_code | STRING | IATA Airport code, if identified otherwise null |
| pickup_airport | STRING | Airport Name, if identified otherwise null |
| pickup_seaport_code | STRING | Seaport code, if identified otherwise null |
| pickup_seaport | TYPE | Seaport name, if identified otherwise null |
| pickup_street | STRING | Pickup street address |
| pickup_address_name | STRING | Pickup company name |
| pickup_state | STRING | The pickup State in case of US or Mexico |
| pickup_zipcode | STRING | The pickup postal code |
| pickup_city | STRING | The pickup city |
| pickup_country | STRING | The pickup country |
| quoted_pickup_date | TIMESTAMP | Quoted pickup date, format YYYY-MM-DD |
| quoted_pickup_time | TIMESTAMP | Quoted pickup time, format HH:MM |
| actual_pickup_date | TIMESTAMP | Quoted or Updated Pickup date. |
| actual_pickup_time | TIMESTAMP | Quoted or Updated Pickup time. |
| pickup_timezone | STRING | Timezone name |
| pickup_notes | STRING | Additional pickup notes |
| pickup_contact_name | STRING | Name of contact person at pickup location |
| pickup_contact_phone | STRING | Phone number of contact person at pickup location |
| pickup_contact_email | STRING | Email of contact person at pickup location |
| pickup_address_type | STRING | Can be Address, Seaport or Airport |
| stop1_airport | STRING | Airport Name, if identified otherwise null |
| stop1_seaport_code | STRING | Seaport code, if identified otherwise null |
| stop1_seaport | TYPE | Seaport name, if identified otherwise null |
| stop1_street | STRING | Delivery street address |
| stop1_address_name | STRING | Delivery company name |
| stop1_state | STRING | The delivery State in case of US or Mexico |
| stop1_zipcode | STRING | The delivery postal code |
| stop1_city | STRING | The delivery city |
| stop1_country | STRING | The delivery country |
| stop1_quoted_delivery_date | TIMESTAMP | Quoted delivery date, format YYYY-MM-DD |
| stop1_quoted_delivery_time | TIMESTAMP | Quoted deliverytime, format HH:MM |
| stop1_actual_delivery_date | TIMESTAMP | Quoted or Updated delivery date. |
| stop1_actual_delivery_time | TIMESTAMP | Quoted or Updated delivery time. |
| stop1_notes | STRING | Additional delivery notes |
| stop1_contact_name | STRING | Name of contact person at delivery location |
| stop1_contact_phone | STRING | Phone number of contact person at delivery location |
| stop1_contact_email | STRING | Email of contact person at delivery location |
| stop1_address_type | STRING | Can be Address, Seaport or Airport |
| pod_date | STRING | Date of delivery |
| pod_signed_by | STRING | Name of person who signed for the POD |
Invoice > financial
Customs details per good item. This category is a child of a handling unit within category Good items.
| Key | Value | Description |
|---|---|---|
| currency | STRING | Currency of the invoice |
| quoted_amount | FLOAT | Amount of the original quote, before moving the shipment |
| amount_due | FLOAT | Amount to be paid, for this invoice |
| total_invoiced_amount | FLOAT | Total amount of all invoices for this shipment (Will be different from amount_due in case of multiple invoices) |
| cost_details | OBJECT | Array with individual line items |
Invoice > financial > cost_details
Details related to the line items of the invoice.
| Key | Value | Description |
|---|---|---|
| title | STRING | Name of the line item, can be a financial item or other classifier |
| value | STRING | String refering to a financial number, or in other case related to weight |
| UOM | STRING | In case of a weight related line item, can be either "KG" or "LBS" |
| currency | STRING | In case of a financial line item, will be the common 3 letter currency acronym |
| sub_title | STRING | Some additional information, mostly for weighted charges, e.g. '4 USD per Kg' |
Known issues
- None at the moment