get-invoice

restish dci get-invoice id

Returns the full details of an invoice specified by the invoice number.

Responses

200 (application/json)

OK - Invoice details returned.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Invoice number, identifying the invoice."
    },
    "invoiceDate": {
      "type": "integer",
      "description": "The time when this invoice was issued, in milliseconds since the epoch.",
      "format": "int64"
    },
    "platform": {
      "type": "string",
      "enum": [
        "google-cloud",
        "amazon-web-services",
        "microsoft-azure",
        "g-suite",
        "office-365",
        "superquery",
        "looker",
        "navigator",
        "solve"
      ]
    },
    "dueDate": {
      "type": "integer",
      "description": "The last day to pay the invoice, in milliseconds since the epoch",
      "format": "int64"
    },
    "status": {
      "type": "string",
      "description": "Status of the invoice",
      "enum": [
        "OPEN",
        "PAST DUE",
        "PAID"
      ]
    },
    "totalAmount": {
      "type": "number",
      "description": "Total invoiced amount",
      "format": "double"
    },
    "balanceAmount": {
      "type": "number",
      "description": "Invoice balance to be paid",
      "format": "double"
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "ILS",
        "EUR",
        "AUD",
        "CAD",
        "GBP",
        "DKK",
        "NOK",
        "SEK",
        "BRL",
        "SGD",
        "MXN",
        "CHF",
        "MYR",
        "TWD",
        "EGP",
        "ZAR",
        "JPY",
        "IDR",
        "AED",
        "THB",
        "COP"
      ]
    },
    "url": {
      "type": "string",
      "description": "Link to [invoice details page](https://help.doit.com/docs/billing/invoices-and-payments/managing-invoices) in the DoiT console. You can download the PDF invoice from the invoice details page."
    },
    "lineItems": {
      "type": "array",
      "description": "Invoice line items.",
      "items": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "details": {
            "type": "string"
          },
          "price": {
            "type": "number",
            "format": "double"
          },
          "qty": {
            "type": "number",
            "format": "double"
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: get-invoice, getinvoice