Returns a list of commercial invoices.
Success
{- "_object": "/api/response",
- "version": 2,
- "data": {
- "_object": "/api/collections/paginated",
- "next": null,
- "data": [
- {
- "_object": "/commercial_invoices",
- "id": "abcxyz-23456-def",
- "invoice_number": "ABCDEFGHIJKLMNOP",
- "digitization_status": "complete",
- "manufacturer_addresses": [
- {
- "_object": "/address",
- "street_address": "1641 Settlers Lane",
- "street_address2": "STE 2918",
- "city": "Albany",
- "state": "MN",
- "country": "United States of America",
- "country_code": "US",
- "zip": "56307",
- "unlocode": "US AL2",
- "timezone": "America/Los_Angeles",
- "ref": "id-3333"
}
], - "total_value": {
- "_object": "/money",
- "amount": "100",
- "currency_code": "USD"
}, - "total_unit_count": "12345",
- "total_weight": {
- "_object": "/quantity/weight",
- "value": 100,
- "unit": "kg"
}, - "total_volume": {
- "_object": "/quantity/volume",
- "value": 100,
- "unit": "cbm"
}, - "line_items": [
- {
- "_object": "/commercial_invoice_line_item",
- "price_per_unit": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "value": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "total_units": 10,
- "container_number": {
- "id": 123,
- "container_number": "XYZ123",
- "commercial_invoice_line_item_id": 12345,
- "deleted_at": null,
- "created_at": "2020-01-01T15:28:03.265Z",
- "updated_at": "2020-01-01T15:28:03.265Z"
}, - "purchase_order_number": "9876-ABC",
- "weight": {
- "_object": "/quantity/weight",
- "value": 12.34,
- "unit": "kg"
}, - "volume": {
- "_object": "/quantity/volume",
- "value": 12.34,
- "unit": "cbm"
}, - "product": {
- "_object": "/api/refs/object",
- "ref_type": "/product",
- "id": 12345
}
}
], - "shipment": {
- "_object": "/api/refs/object",
- "ref_type": "/shipment",
- "id": 123456
}
}
]
}
}
The created commercial invoice
_object | string | ||||||||||||||||||||||||||||
self | string | ||||||||||||||||||||||||||||
version | integer | ||||||||||||||||||||||||||||
object (CommercialInvoice) | |||||||||||||||||||||||||||||
|
{- "shipment_id": 79683,
- "shipment_ref": "PO-123",
- "invoice_number": "INVOICE-04-05-2020",
- "involved_parties": [
- {
- "type": "string",
- "company_entity_ref": "string"
}
], - "currency_code": "USD",
- "is_related_parties": false,
- "proration_amount": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "manufacturer_refs": [
- "string"
], - "line_items": [
- {
- "_object": "/commercial_invoice_line_item/create",
- "document_line_number": 4,
- "purchase_order_number": "9876-ABC",
- "po_line_item_number": 12,
- "container_number": "522932-1",
- "country_of_origin": "CN",
- "product_sku": "PRODUCT-123",
- "manufacturer_ref": "string",
- "quantity": {
- "value": 0,
- "unit": "pcs"
}, - "net_value": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "first_sale_value": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "value": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "price_per_unit": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "gross_weight": {
- "value": 2300.4,
- "unit": "kg"
}, - "net_weight": {
- "value": 2300.4,
- "unit": "kg"
}, - "net_net_weight": {
- "value": 2300.4,
- "unit": "kg"
}, - "volume": {
- "value": 472.62,
- "unit": "cbm"
}, - "metadata": "{color: [\"red\", \"blue\"], size: [\"large\", \"medium\", \"small\"]}"
}
], - "metadata": "{color: [\"red\", \"blue\"], size: [\"large\", \"medium\", \"small\"]}"
}
Success
{- "_object": "/api/response",
- "version": 2,
- "data": {
- "_object": "/commercial_invoice",
- "id": "abcxyz-23456-def",
- "invoice_number": "ABCDEFGHIJKLMNOP",
- "digitization_status": "complete",
- "manufacturer_addresses": [
- {
- "_object": "/address",
- "street_address": "1641 Settlers Lane",
- "street_address2": "STE 2918",
- "city": "Albany",
- "state": "MN",
- "country": "United States of America",
- "country_code": "US",
- "zip": "56307",
- "unlocode": "US AL2",
- "timezone": "America/Los_Angeles",
- "ref": "id-3333"
}
], - "total_value": {
- "_object": "/money",
- "amount": "100",
- "currency_code": "USD"
}, - "total_unit_count": "12345",
- "total_weight": {
- "_object": "/quantity/weight",
- "value": 100,
- "unit": "kg"
}, - "total_volume": {
- "_object": "/quantity/volume",
- "value": 100,
- "unit": "cbm"
}, - "line_items": [
- {
- "_object": "/commercial_invoice_line_item",
- "price_per_unit": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "value": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "total_units": 10,
- "container_number": {
- "id": 123,
- "container_number": "XYZ123",
- "commercial_invoice_line_item_id": 12345,
- "deleted_at": null,
- "created_at": "2020-01-01T15:28:03.265Z",
- "updated_at": "2020-01-01T15:28:03.265Z"
}, - "purchase_order_number": "9876-ABC",
- "weight": {
- "_object": "/quantity/weight",
- "value": 12.34,
- "unit": "kg"
}, - "volume": {
- "_object": "/quantity/volume",
- "value": 12.34,
- "unit": "cbm"
}, - "product": {
- "_object": "/api/refs/object",
- "ref_type": "/product",
- "id": 12345
}
}
], - "shipment": {
- "_object": "/api/refs/object",
- "ref_type": "/shipment",
- "id": 123456
}
}
}
invoice_number | string Invoice number on the commercial invoice, typically used for display purposes. Uniqueness is based on the supplier Involved Party. There can be multiple commercial invoices with the same invoice_number only if they have different suppliers. | ||||||||||||||||||||||||||||||||||||
currency_code | string The currency being used on the commercial invoice. | ||||||||||||||||||||||||||||||||||||
is_related_parties | boolean Whether there was a related parties transaction as defined by CBP. | ||||||||||||||||||||||||||||||||||||
object (Money) | |||||||||||||||||||||||||||||||||||||
manufacturer_refs | Array of strings | ||||||||||||||||||||||||||||||||||||
Array of objects (CreateCommercialInvoiceLineItem) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
metadata | object (Metadata) Set of custom key-values specific to the object. The keys are strings and values are arrays of strings. The set of valid keys is always the consignee's list of keys, even if call was made by a different party. |
The updated commercial invoice
_object | string | ||||||||||||||||||||||||||||
self | string | ||||||||||||||||||||||||||||
version | integer | ||||||||||||||||||||||||||||
object (CommercialInvoice) | |||||||||||||||||||||||||||||
|
{- "invoice_number": "INVOICE-04-05-2020",
- "currency_code": "USD",
- "is_related_parties": false,
- "proration_amount": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "manufacturer_refs": [
- "string"
], - "line_items": [
- {
- "_object": "/commercial_invoice_line_item/create",
- "document_line_number": 4,
- "purchase_order_number": "9876-ABC",
- "po_line_item_number": 12,
- "container_number": "522932-1",
- "country_of_origin": "CN",
- "product_sku": "PRODUCT-123",
- "manufacturer_ref": "string",
- "quantity": {
- "value": 0,
- "unit": "pcs"
}, - "net_value": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "first_sale_value": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "value": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "price_per_unit": {
- "amount": "12.34",
- "currency_code": "USD"
}, - "gross_weight": {
- "value": 2300.4,
- "unit": "kg"
}, - "net_weight": {
- "value": 2300.4,
- "unit": "kg"
}, - "net_net_weight": {
- "value": 2300.4,
- "unit": "kg"
}, - "volume": {
- "value": 472.62,
- "unit": "cbm"
}, - "metadata": "{color: [\"red\", \"blue\"], size: [\"large\", \"medium\", \"small\"]}"
}
], - "metadata": {
- "purchase_order": [
- "12345"
], - "sku": [
- "abc123"
]
}
}
Success
{- "_object": "/api/response",
- "version": 2,
- "data": {
- "_object": "/commercial_invoice",
- "id": "abcxyz-23456-def",
- "invoice_number": "ABCDEFGHIJKLMNOP",
- "digitization_status": "complete",
- "manufacturer_addresses": [
- {
- "_object": "/address",
- "street_address": "1641 Settlers Lane",
- "street_address2": "STE 2918",
- "city": "Albany",
- "state": "MN",
- "country": "United States of America",
- "country_code": "US",
- "zip": "56307",
- "unlocode": "US AL2",
- "timezone": "America/Los_Angeles",
- "ref": "id-3333"
}
], - "total_value": {
- "_object": "/money",
- "amount": "100",
- "currency_code": "USD"
}, - "total_unit_count": "12345",
- "total_weight": {
- "_object": "/quantity/weight",
- "value": 100,
- "unit": "kg"
}, - "total_volume": {
- "_object": "/quantity/volume",
- "value": 100,
- "unit": "cbm"
}, - "line_items": [
- {
- "_object": "/commercial_invoice_line_item",
- "price_per_unit": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "value": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "total_units": 10,
- "container_number": {
- "id": 123,
- "container_number": "XYZ123",
- "commercial_invoice_line_item_id": 12345,
- "deleted_at": null,
- "created_at": "2020-01-01T15:28:03.265Z",
- "updated_at": "2020-01-01T15:28:03.265Z"
}, - "purchase_order_number": "9876-ABC",
- "weight": {
- "_object": "/quantity/weight",
- "value": 12.34,
- "unit": "kg"
}, - "volume": {
- "_object": "/quantity/volume",
- "value": 12.34,
- "unit": "cbm"
}, - "product": {
- "_object": "/api/refs/object",
- "ref_type": "/product",
- "id": 12345
}
}
], - "shipment": {
- "_object": "/api/refs/object",
- "ref_type": "/shipment",
- "id": 123456
}
}
}
Retrieves the details of a single commercial invoice.
Success
_object | string | ||||||||||||||||||||||||||||
self | string | ||||||||||||||||||||||||||||
version | integer | ||||||||||||||||||||||||||||
object (CommercialInvoice) | |||||||||||||||||||||||||||||
|
Success
{- "_object": "/api/response",
- "version": 2,
- "data": {
- "_object": "/commercial_invoice",
- "id": "abcxyz-23456-def",
- "invoice_number": "ABCDEFGHIJKLMNOP",
- "digitization_status": "complete",
- "manufacturer_addresses": [
- {
- "_object": "/address",
- "street_address": "1641 Settlers Lane",
- "street_address2": "STE 2918",
- "city": "Albany",
- "state": "MN",
- "country": "United States of America",
- "country_code": "US",
- "zip": "56307",
- "unlocode": "US AL2",
- "timezone": "America/Los_Angeles",
- "ref": "id-3333"
}
], - "total_value": {
- "_object": "/money",
- "amount": "100",
- "currency_code": "USD"
}, - "total_unit_count": "12345",
- "total_weight": {
- "_object": "/quantity/weight",
- "value": 100,
- "unit": "kg"
}, - "total_volume": {
- "_object": "/quantity/volume",
- "value": 100,
- "unit": "cbm"
}, - "line_items": [
- {
- "_object": "/commercial_invoice_line_item",
- "price_per_unit": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "value": {
- "_object": "/money",
- "amount": "12.34",
- "currency_code": "USD"
}, - "total_units": 10,
- "container_number": {
- "id": 123,
- "container_number": "XYZ123",
- "commercial_invoice_line_item_id": 12345,
- "deleted_at": null,
- "created_at": "2020-01-01T15:28:03.265Z",
- "updated_at": "2020-01-01T15:28:03.265Z"
}, - "purchase_order_number": "9876-ABC",
- "weight": {
- "_object": "/quantity/weight",
- "value": 12.34,
- "unit": "kg"
}, - "volume": {
- "_object": "/quantity/volume",
- "value": 12.34,
- "unit": "cbm"
}, - "product": {
- "_object": "/api/refs/object",
- "ref_type": "/product",
- "id": 12345
}
}
], - "shipment": {
- "_object": "/api/refs/object",
- "ref_type": "/shipment",
- "id": 123456
}
}
}