Invoices: list

Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.

Privileges required: account administrator

Request

HTTP request

GET /v2/accounts/{accountId}/billing_invoices

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

Optional Query Parameters
from_datestring

Specifies the date/time of the earliest invoice in the account to retrieve.

to_datestring

Specifies the date/time of the latest invoice in the account to retrieve.

Responses

CodeDescriptionReference
200

Successful response.

billingInvoicesResponse
400

Error encountered.

errorDetails

SDK Method

Billing::listInvoices

Definitions

billingInvoiceItem

Contains information about an item on a billing invoice.

chargeAmountstring

Reserved: TBD

chargeNamestring

Reserved: TBD

invoiceItemIdstring

Reserved: TBD

quantitystring

The quantity of envelopes to add to the account.

unitPricestring

Reserved: TBD

billingInvoicesResponse

Defines a billing invoice response object.

billingInvoices[Invoices]

Reserved: TBD

nextUristring

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUristring

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

Invoices

Invoices

amountstring

Reserved: TBD

balancestring

Reserved: TBD

dueDatestring

Reserved: TBD

invoiceIdstring

Reserved: TBD

invoiceItems[billingInvoiceItem]

Reserved: TBD

invoiceNumberstring

Reserved: TBD

invoiceUristring

Contains a URI for an endpoint that you can use to retrieve invoice information.

nonTaxableAmountstring

pdfAvailablestring

taxableAmountstring

Examples

Generic JSON Response

Response
{
  "billingInvoices": [
    {
      "amount": "sample string 1",
      "taxableAmount": "sample string 2",
      "nonTaxableAmount": "sample string 3",
      "balance": "sample string 4",
      "dueDate": "sample string 5",
      "invoiceId": "sample string 6",
      "invoiceNumber": "sample string 7",
      "pdfAvailable": "sample string 8",
      "invoiceUri": "sample string 9",
      "invoiceItems": [
        {
          "chargeAmount": "sample string 1",
          "chargeName": "sample string 2",
          "invoiceItemId": "sample string 3",
          "quantity": "sample string 4",
          "unitPrice": "sample string 5"
        }
      ]
    }
  ],
  "nextUri": "sample string 1",
  "previousUri": "sample string 2"
}
Generic XML Response

Response
<billingInvoicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <billingInvoices>
    <billingInvoice>
      <amount>sample string 1</amount>
      <balance>sample string 4</balance>
      <dueDate>sample string 5</dueDate>
      <invoiceId>sample string 6</invoiceId>
      <invoiceItems>
        <billingInvoiceItem>
          <chargeAmount>sample string 1</chargeAmount>
          <chargeName>sample string 2</chargeName>
          <invoiceItemId>sample string 3</invoiceItemId>
          <quantity>sample string 4</quantity>
          <unitPrice>sample string 5</unitPrice>
        </billingInvoiceItem>
      </invoiceItems>
      <invoiceNumber>sample string 7</invoiceNumber>
      <invoiceUri>sample string 9</invoiceUri>
      <nonTaxableAmount>sample string 3</nonTaxableAmount>
      <pdfAvailable>sample string 8</pdfAvailable>
      <taxableAmount>sample string 2</taxableAmount>
    </billingInvoice>
  </billingInvoices>
  <nextUri>sample string 1</nextUri>
  <previousUri>sample string 2</previousUri>
</billingInvoicesResponse> 
}} />