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.

FieldDefinition or Sample Data
shipment_idshp_….
label_date2020-03-13T14:16:44Z
carrier_account_idca_...
carrierName of the carrier
tracking_code94001293405...
carrier_invoice_idNullable… invoice reference if provided by the carrier
package_dispute_idValue to be referenced if you need to file a dispute
status“processed” or “disputed”
quoted_currencyThe currency associated with the shipment[selected_rate][rate]
initially_paid_amountThe postage fee that was incurred at the time of label creation
quoted_amountshipment[selected_rate][rate]
claimed_lengthshipment[parcel][length]
claimed_widthshipment[parcel][width]
claimed_heightshipment[parcel][height]
claimed_packageshipment[parcel][predefined_package]
claimed_serviceshipment[selected_rate][service]
final_invoice_amountThe 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_currencyThe currency associated with the final invoice amount
adjustment_amount The difference between the initially_paid_amount and the final_invoice_amount
adjustment_reasonThe standardized reason for the adjustment
invoice_dateThe date the User balance was adjusted
initially_paid_payment_logThe payment log associated with the initial payment
invoice_payment_logThe payment log associated with the adjustment_amount
user_iduser_...
user_parent_iduser_...
View a sample CSV report.

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_...."
}
    
Don't see your question? Talk to a shipping expert