Invoice Object

A successful GET from a invoices endpoint will return an invoice object.

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

Example Object

200 /v1/invoices/12904

  {
    "id": 12904,
    "status": "closed", 
    "due_amount": 45.01, 
    "paid_amount": 35.01, 
    "discount_amount": 10, 
    "balance_remaining":  0, 
    "payments": [
    {
      "amount" : 45.01,
      "date" : "2023-04-25T23:59:59+00:00", 
      "status": "paid", 
      "method": {
        "id": 12,
        "type": "ach/card",
        "last4": 1234
      },
      "charges": [
        { 
          "id": 123,
          "amount": 123
        }
      ]
    }
    ],
    "start_datetime": "2023-04-09T00:00:00+00:00",
    "end_datetime": "2023-04-15T23:59:59+00:00",
    "customer": {
      "id": 108,
      "name": "Dealer name"
    },
    "charges": [ 
      {
        "id": 123,
        "move_id": 85788, // optional, only if charge type is move
        "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"
          }
        ]
      }
    ]
  }

Response Field Descriptions

Field	Type	Description
id	Number	The unique identifier of the invoice.
status	String	The status of the invoice: acquiring - The invoice is still being updated with active moves. Once the invoice is closed, it will no longer be updated with new charges. processing - The invoice is being processed and moves can no longer be added to it. closed - The invoice is settled and will no longer receive any changes.
due_amount	Number	The amount due on the invoice.
paid_amount	Number	The amount paid on the invoice.
discount_amount	Number	The discount amount applied to the invoice if any.
balance_remaining	Number	The remaining balance for the invoice.
start_datetime	String	The start date and time of the invoice.
end_datetime	String	The end date and time of the invoice.
amount	Number	The amount that was paid for a specific transaction.
date	String	The date and time of the payment.
status	String	The status of the payment on the invoice: processing - The payment is being processed. paid - The payment has been processed and the invoice is paid. failed - The payment has failed to process. The failure reason will also be included to give more context as to why the payment failed.
method	Object	An object containing payment method information.
id	Number	The unique identifier of the charge.
move_id	Number	The identifier of the move associated with the charge (optional).
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.
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 miles traveled.
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.