Invoices: listPastDue

Returns a list past due invoices for the account and notes if payment can be made through the REST API.

Privileges Required: account administrator

Request

HTTP request

GET /v2.1/accounts/{accountId}/billing_invoices_past_due

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

billingInvoicesSummary
400

Error encountered.

errorDetails

SDK Method

Billing::listInvoicesPastDue

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

billingInvoicesSummary

billingInvoices[Invoices]

Reserved: TBD

pastDueBalancestring

paymentAllowedstring

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

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
{
  "pastDueBalance": "sample string 1",
  "paymentAllowed": "sample string 2",
  "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"
        }
      ]
    }
  ]
}
Generic XML Response

Response
<billingInvoiceSummary 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>
  <pastDueBalance>sample string 1</pastDueBalance>
  <paymentAllowed>sample string 2</paymentAllowed>
</billingInvoiceSummary> 
}} />