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/accounts/{accountId}/billing_invoices_past_due

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Billing::listInvoicesPastDue

Definitions Expand All | Collapse All

Invoices

Invoices

amount string

Reserved: TBD

balance string

Reserved: TBD

dueDate string

Reserved: TBD

invoiceId string

Reserved: TBD

invoiceItems
[billingInvoiceItem]

Reserved: TBD

invoiceNumber string

Reserved: TBD

invoiceUri string

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

nonTaxableAmount string
pdfAvailable string
taxableAmount string

billingInvoiceItem

Contains information about an item on a billing invoice.

chargeAmount string

Reserved: TBD

chargeName string

Reserved: TBD

invoiceItemId string

Reserved: TBD

quantity string

The quantity of envelopes to add to the account.

unitPrice string

Reserved: TBD

billingInvoicesSummary

billingInvoices
[Invoices]

Reserved: TBD

pastDueBalance string
paymentAllowed string

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

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>