Invoices API

Summary

Resource	Operation	Description
Invoice Status	GET /dcs/(dc_id)/routes/(route_id)/invoices	Get all Invoice status for the route

Details

GET /dcs/(dc_id)/routes/(route_id)/invoices

Parameters:

• dc_id (string) – The dc id
• route_id (string) – The route id

Status Codes:

• 200 OK – Invoice Status was returned.
• 400 Bad Request – Check error code within the response.
• 401 Unauthorized – API key is invalid.
• 403 Forbidden – DC does not exist or user does not have permission to access it.

Error Code	Description
3003	Route with that id does not exist.

Example response

{
  "status": "success",
  "data": {
    "invoices": [{
      "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
        }
      }]
    }, {
      "id": "globally unique invoice id 2",
      "payment_method": "CASH",
      "invoice_name_attributes": [{"key": "Customer TAX ID", "value": "A-1232-001"}],
      "items": [{
        "id": "globally unique item id 2",
        "sku": "sku B",
        "name": "name B",
        "quantity": 123.0,
        "total_price_cents": 9999,
        "currency": "USD",
        "status": {
          "status": "FAILED",
          "timestamp": 1531267636897,
          "reason": {
            "code": "00001",
            "message": "Customer closed"
          }
        }
      }]
    }]
  }
}