API referenceReference
Rebills
What a rebill is, how its review works, and what each status, dispute status and line item type means.
A carrier can bill more than the quoted price after it moves a shipment. It reweighs the freight and finds it heavier, the driver waits at the dock, or the first delivery attempt fails. Mothership passes those charges on as a rebill, with one line item per charge.
A rebill belongs to one shipment. The first rebill on MS5016101 is MSSR5016101, and a second one is MSSR5016101-2. Retrieve a rebill takes either the reference number or the rebill's id.
The API reads rebills and their disputes. Accepting a charge, disputing it and answering Mothership's questions happen on the Billing page in your dashboard.
The review window
A new rebill is scheduled. Until disputableUntil, you can accept each line item or dispute it. Line items you leave alone are charged as billed when the window closes.
To find the rebills that need you, list them with status=scheduled. To find the disputes where Mothership is waiting on you, list them with disputeStatus=info-needed. Each takes one call to List rebills, because filters on different parameters must all match.
Amounts
Every amount is in cents, in US dollars. amountCents is the total of the line items, processingFeeCents is the carrier bill processing fee, and totalAmountCents is the two together. The processing fee may apply if the rebill is finalized or a dispute is lost.
A line item whose dispute is approved isn't charged, and a waived or voided rebill costs nothing. Once the review is over, invoiceId names the invoice that charges the rebill. Retrieve an invoice shows what was charged and whether it has been paid.
Rebill statuses
| Status | Description |
|---|---|
scheduled | Waiting for your review. Accept or dispute each line item in your dashboard before disputableUntil. Line items you leave alone are charged as billed when the window closes. |
disputed | At least one line item is disputed. Each line item's dispute.status says where its dispute is. |
accepted | You accepted every line item. Mothership finalizes the rebill and charges it next. |
finalized | The review is over and the charge is being made. Line items with an approved dispute are left out, and invoiceId names the invoice. |
processed | Mothership finished processing the rebill. That doesn't mean the invoice is paid, so check invoiceId with Retrieve an invoice. |
failed | Mothership couldn't charge the rebill automatically. Pay the open invoice in invoiceId. |
waived | Mothership covered the charge. You pay nothing. |
voided | The rebill was cancelled. You pay nothing. |
Disputes
A line item has at most one dispute. It shows up as the line item's dispute, and List a rebill's disputes lists every dispute on a rebill in one array. reason and message are what you wrote when you disputed the charge, and fileIds are the files you attached, which Retrieve a file downloads.
Dispute statuses
| Status | Description |
|---|---|
under-review | Mothership is reviewing your dispute before it goes to the carrier. This usually takes 1 to 2 days. |
with-carrier | Mothership sent the dispute to the carrier and is waiting for its decision, which usually takes 5 to 7 business days. |
info-needed | Mothership needs more from you, and infoRequested says what. Reply from your dashboard within 7 days, or the dispute is withdrawn and the line item is charged. |
resolved-approved | The carrier approved the dispute. You aren't charged for the line item. |
resolved-waived-approved | Mothership waived the line item in your favor. You aren't charged for it. |
resolved-charged | The carrier upheld the charge, so the line item is charged. |
withdrawn | You withdrew the dispute and accepted the charge. |
voided | Closed because the rebill was waived or voided. |
Line item types
Each line item's type says what the carrier charged for. name is the same charge as the dashboard names it, and explanation, avoidanceGuidance and disputeEvidence explain it in Markdown.
| Line item type | Description |
|---|---|
bill-of-lading-correction | The carrier corrected details on the bill of lading. |
reconsignment | The delivery address changed after pickup, so the carrier rerouted the freight. |
delivery-attempt | The carrier tried to deliver but couldn't, and came back. |
driver-labor | The driver loaded or unloaded the freight. |
expedited-delivery | The freight moved faster than the service you booked. |
additional-freight | The carrier picked up more freight than you booked. |
lumper-fee | Workers at the dock were paid to load or unload the freight. |
pickup-address-change | The pickup address changed after booking. |
pickup-attempt | The carrier came for the freight but couldn't pick it up, such as when it wasn't ready. |
reactivated-shipment | The carrier restarted a shipment that had been cancelled or put on hold. |
return-shipment | The carrier brought the freight back to the shipper. |
detention | The driver waited at pickup or delivery longer than the free time the carrier allows. |
incorrect-weight | The carrier weighed the freight and found it heavier than booked. |
liftgate-pickup | The driver used a liftgate to load the freight at pickup. |
liftgate-delivery | The driver used a liftgate to unload the freight at delivery. |
incorrect-dimensions | The carrier measured the freight and found it larger than booked. |
appointment | The carrier had to book an appointment to pick up or deliver. |
residential-pickup | The pickup was at a residential address. |
residential-delivery | The delivery was to a residential address. |
inside-pickup | The driver collected the freight from inside the building. |
inside-delivery | The driver brought the freight inside the building. |
excessive-length | A piece of freight was longer than the carrier's standard length. |
commodity-class-up | The carrier rated the freight at a higher freight class than booked. |
tradeshow | The pickup or delivery was at a trade show or convention. |
blind-shipment | The paperwork kept the shipper and consignee from seeing each other. |
government-airport-gas-mine-or-refinery-delivery | The delivery was to a government site, an airport, a gas or oil site, a mine or a refinery. |
container-freight-station-pickup | The pickup was at a container freight station. |
container-freight-station-delivery | The delivery was to a container freight station. |
storage-fee | The carrier stored the freight, such as while it waited to deliver. |
amazon-distribution-center | The delivery was to an Amazon distribution center. |
call-before-delivery | The carrier called the consignee before delivering. |
carrier-or-service-upgrade | The shipment moved with a different carrier or a higher service level than booked. |
limited-truck-access-pickup | The pickup location was hard for a truck to reach. |
limited-truck-access-delivery | The delivery location was hard for a truck to reach. |
hazmat | The freight contained hazardous materials. |
toll-fee | Tolls on the route. |
freight-coverage | Coverage for loss of or damage to the freight. |
oversize-fee | The freight was larger or heavier than the carrier's standard limits. |
scheduled-delivery | The delivery was scheduled for a set time. |
documentation | The carrier prepared or handled paperwork for the shipment. |
cancellation-fee | The carrier charged for a cancellation, usually one made close to the pickup time. |
cargo-details-updated | The carrier inspected the freight and found its weight, dimensions or commodity didn't match the booking. |
No rows match.