Invoice Status

After importing invoiced routes, invoices statuses can be checked using the invoice status endpoint.

Models

Invoice Status

Property	Type	Nullable	Description
id	string	false	The globally unique id of this invoice.
payment_method	Payment Method	false	The payment method for this invoice.
invoice_name_attributes	Array[Invoice Name Attribute]	false	Extra attributes for this invoice to give your operation more context. For example: {“key”: “Invoice Tax ID”, “value”: “432-22”}
items	Array[Invoice Item Status]	false	An array of invoice item status.

{
  "id": "globally unique invoice id",
  "payment_method": "CASH",
  "invoice_name_attributes": [{"key": "Customer TAX ID", "value": "A-1232-001"}],
  "items": [{
    "id": "globally unique item id",
    "sku": "sku A",
    "name": "name A",
    "quantity": 123.0,
    "total_price_cents": 9999,
    "currency": "USD",
    "status": {
      "status": "SUCCESSFUL",
      "timestamp": 1531267636897
    }
  }]
}

Invoice Item Status

Property	Type	Nullable	Description
id	string	false	The globally unique id of this invoice item.
sku	string	false	The SKU of this product.
name	string	false	The name of this product.
quantity	float	false	The quantity of this product.
total_price_cents	integer	false	The total price for this line item including quantities, in cents.
currency	string	false	The currency code representing the currency used to pay for the item.
status	Status	true	The current delivery status of the item. If this is null, then it might be pending.

{
  "id": "globally unique item id",
  "sku": "sku A",
  "name": "name A",
  "quantity": 123.0,
  "total_price_cents": 9999,
  "currency": "USD",
  "status": {
    "status": "SUCCESSFUL",
    "timestamp": 1531267636897
  }
}

Status

Property	Type	Nullable	Description
status	Delivery Status	false	The delivery status of the item. This is the final status this invoice had (ie, at the beginning of the route it was marked as FAILED, then was reattempted and marked as SUCCESSFUL, this’ll show the latter with the respective timestamp).
timestamp	long	false	The timestamp of the delivery status as a UNIX epoch since January 1st, 1970 in milliseconds.

{
  "status": "SUCCESSFUL",
  "timestamp": 1531267636897
}