What is a Shipment Invoice?
EasyPost has a few products that get billed asynchronously. To help inform customers about this billing activity, EasyPost provides a shipment invoice report and a shipment invoice webhook event.
Shipment Invoice Report
You can access this in a .CSV format through our Reports Object, which you can learn more about here.
The CSV file contains the fields listed below with their definitions.
| Field | Definition or Sample Data |
|---|---|
| shipment_id | shp_…. |
| label_date | 2020-03-13T14:16:44Z |
| carrier_account_id | ca_... |
| carrier | Name of the carrier |
| tracking_code | 94001293405... |
| carrier_invoice_id | Nullable… invoice reference if provided by the carrier |
| package_dispute_id | Value to be referenced if you need to file a dispute |
| status | “processed” or “disputed” |
| quoted_currency | The currency associated with the shipment[selected_rate][rate] |
| initially_paid_amount | The postage fee that was incurred at the time of label creation |
| quoted_amount | shipment[selected_rate][rate] |
| claimed_length | shipment[parcel][length] |
| claimed_width | shipment[parcel][width] |
| claimed_height | shipment[parcel][height] |
| claimed_package | shipment[parcel][predefined_package] |
| claimed_service | shipment[selected_rate][service] |
| final_invoice_amount | The total amount that is due for the shipment |
| captured_length | The length of the package captured by the carrier upon processing the shipment. |
| captured_width | The width of the package captured by the carrier upon processing the shipment. |
| captured_height | The height of the package captured by the carrier upon processing the shipment. |
| captured_weight | The weight of the package captured by the carrier upon processing the shipment. |
| captured_package | The package type captured by the carrier upon processing the shipment. |
| captured_service | The service level determined by the carrier upon processing the shipment (ie - Service changed to Priority instead of First Class due to weight discrepancy) |
| captured_currency | The currency associated with the final invoice amount |
| adjustment_amount | The difference between the initially_paid_amount and the final_invoice_amount |
| adjustment_reason | The standardized reason for the adjustment |
| invoice_date | The date the User balance was adjusted |
| initially_paid_payment_log | The payment log associated with the initial payment |
| invoice_payment_log | The payment log associated with the adjustment_amount |
| user_id | user_... |
| user_parent_id | user_... |
Shipment Invoice Event
If you have a webhook associated with your EasyPost account, EasyPost will send you a webhook event whenever a shipment is audited and your balance is adjusted.
{
"result":{
"id":"ppshp_....",
"object":"ShipmentInvoice",
"mode":"production",
"status":"processed",
"user_id":"user_....",
"order_id":null,
"shipment_id":"shp_....",
"tracking_code":"94001....",
"label_date":"2020-03-16 17:40:24 UTC",
"quoted_amount":"5.12",
"quoted_currency":"USD",
"initially_paid_amount":"5.12000",
"initially_paid_currency":"US5",
"initially_paid_payment_log":"paylog_....",
"adjustment_reason":"Weight",
"adjustment_amount":"-2.34000",
"invoice_type":"adjustment",
"invoice_amount":"-2.34000",
"invoice_currency":"US5",
"invoice_payment_log":"paylog_....",
"total_cost":"2.78000",
"carrier_account":"ca_....",
"carrier":"USPS",
"claimed_details":{
"from_address":{
"zip":"40258-2850",
"state":"KY",
"country":"US"
},
"to_address":{
"zip":"23451-3714",
"state":"VA",
"country":"US"
},
"parcel":{
"length":null,
"width":null,
"height":null,
"weight":13,
"predefined_package":null
},
"service":"First",
"carrier":"USPS"
},
"captured_details":{
"from_address":{
"zip":"40258-2850",
"state":"KY",
"country":"US"
},
"to_address":{
"zip":"23451-3714",
"state":"VA",
"country":"US"
},
"parcel":{
"length":null,
"width":null,
"height":null,
"weight":1.3,
"predefined_package":null
},
"service":"First",
"carrier":"USPS"
}
},
"description":"shipment.invoice.created",
"mode":"production",
"previous_attributes":null,
"completed_urls":null,
"user_id":"user_....",
"status":"pending",
"object":"Event",
"id":"evt_...."
}