Skip to main content

list-invoices 

dci list-invoices [flags]

Returns a list of all the current and historical invoices for your organization. Invoices are returned in reverse chronological order by default.

Flags​

--max-results: (integer format:int64 default:50)

--page-token: (string)

--filter: (string) An expression for filtering the results. The syntax is key:[<value>]. Multiple filters can be connected using a pipe |. See Filters.

--min-creation-time: (integer format:int64)

--max-creation-time: (integer format:int64)

Responses​

200 (application/json)​

OK - All available invoices returned.

{
  "type": "object",
  "properties": {
    "invoices": {
      "type": "array",
      "description": "Array of Invoices",
      "items": {
        "type": "object",
        "description": "Summary information about an invoice.",
        "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",
            "description": "Platform identifier for invoice source.",
            "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": {
            "description": "Currency code for monetary values.",
            "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."
          }
        }
      }
    },
    "pageToken": {
      "type": "string",
      "description": "Page token. Can be used to request the next page of results."
    },
    "rowCount": {
      "type": "integer",
      "description": "Invoice rows count",
      "format": "int64"
    }
  }
}

400 (application/problem+json)​

Syntactically malformed request, missing required parameter, or unsupported parameter value.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

401 (application/problem+json)​

Missing or invalid credentials.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

403 (application/problem+json)​

Authenticated but not authorised to access the requested resource.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

404 (application/problem+json)​

The requested resource does not exist.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

500 (application/problem+json)​

Unexpected server error.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  }
}

Aliases: listinvoices