Charge Object

A successful GET from the moves endpoint will return the moves object with the addition of the charge object if there is an associated charge. The charge object will include all the charge details associated with the move. Until the move is marked as settled (see move object), a charge can be added or changed.

For unsuccessful requests, please refer to Error Handling and Error Codes.

Example Object

200 /v1/moves/12904

{
  "move": {
    "vehicle": [object]
  },
  "pickup_location": [object],
  "delivery_location": [object],
  "pickup_photos": [array],
  "delivery_photos": [array],
  "charge":{
    "invoice_id": 85788,
    "type": "move",
    "status": "paid",
    "disputed": false,
    "dispute_reason": "description...",
    "discount_amount": 12.00,
    "discount_reason": "description...",
    "due_amount": 45.01, 
    "paid_amount": 45.01,
    "balance_remaining": 0,
    "details": [
      {
        "name": "Transport",
        "amount": 44.87,
        "notes": "Standard transport cost of move",
        "mileage_band": {
          "rate": 6,
          "type": "flat",
          "distance_start": 0,
          "distance_end": 666,
          "contract": {
            "begin_date": "2023-08-01T04:00:00+00:00",
            "end_date": "2028-08-31T04:00:00+00:00",
            "workflowset_id": 3
          }
        }
      },
      {
        "name": "Surge",
        "amount": 0.14,
        "notes": "uber ride service"
      },
      {
        "name": "Fuel",
        "amount": 15.82,
        "notes": "We calculated 2.32 gallons of gas required based on the estimated MPG, fuel level at vehicle pickup, and target fuel level at delivery.",
        "documents": [
          {
            "name": "receipt",
            "url" : "https://www.example.com/fuel-receipt.pdf",
            "created_at": "2023-08-01T04:00:00+00:00",
            "mime-type": "application/pdf"  
          }
        ]
      }
    ]
  }
}

Response Field Descriptions

Field	Type	Description
id	Number	The unique identifier of the charge.
invoice_id	Number	The identifier of the invoice associated with the charges.
type	String	The type of the charge: fee - An additional charge added to the invoice. This is usually a credit card transaction fee. move - A charge that is related to a move. one-time - A one-time charge (i.e. onboarding fee). prepaid - The charge related to prepaid product move packages.
status	String	The status of the charge: unpaid - The initial status of an invoice that stays until partial or full payment has been received. partial - The status used when a partial payment has been received that leaves a balance due. paid - The final status that indicates the full payment has been received.
disputed	Boolean	Indicates whether the charge is disputed.
dispute_reason	String	The reason for the dispute (if applicable).
discount_amount	Number	The discount amount applied to the charge.
discount_reason	String	The reason for the discount (if applicable).
name	String	The name/type of the charge detail: delay - The charge if a driver was delayed during the move (i.e. vehicle was not ready, paperwork not ready, etc) fuel - The charge applied when the driver had to add fuel to the vehicle to complete the move. insurance - The charge for a move that required an additional insurance charge outside of the standard insurance rate. partial - The charge for a move that was canceled after the driver was already dispatched. ride - The charge when a move requires an additional ride. This usually occurs when a move has been canceled when the driver was already dispatched and the driver needs to get to their next destination. surge - The charge for surge pricing for rideshare. toll - The charge applied if there was a toll paid during the move. tow - The charge applied if a tow was required due to issues with the vehicle.
amount	Number	The amount of the charge detail.
notes	String	Additional notes or description for the charge detail.
documents	Array	An array of documents associated with the charge detail.
rate	Number	The rate of the mileage band.
type	String	The type of the mileage band: flat - A flat rate for the mileage band. per - A rate based on per miles traveled.
class	String	The class of the mileage band: base - applies to moves for which no external return ride to the origin is required. stranded - applies to moves for which an external return ride to the origin is required. stranded_x2, stranded_x3, etc. - if specified in your contract, indicates rates for stranded moves that were able to be grouped together for efficiency (x2 = two moves grouped, x3 = three moves grouped, etc.).
distance_start	Number	The starting distance of the mileage band.
distance_end	Number	The ending distance of the mileage band.
begin_date	String	The start date of the contract.
end_date	String	The end date of the contract.
workflowset_id	Number	The id of the workflow set of the contract.