Retrieves the specified invoice.

Note: If the pdfAvailable property in the response is set to true, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the Accept property in the header to Accept: application/pdf.

Privileges required: account administrator

The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.

Response The following table provides a description of the different chargeName property values. The information will grow as more chargeable items are added to the system.

chargeName Description
id_check ID Check Charge
in_person_signing In Person Signing charge
envelopes Included Sent Envelopes for the account
age_verify Age verification check
ofac OFAC Check
id_confirm ID confirmation check
student_authentication STAN PIN authentication check
wet_sign_fax Pages for returning signed documents by fax
attachment_fax Pages for returning attachments by fax
phone_authentication Phone authentication charge
powerforms PowerForm envelopes sent
signer_payments Payment processing charge
outbound_fax Send by fax charge
bulk_recipient_envelopes Bulk Recipient Envelopes sent
sms_authentications SMS authentication charge
saml_authentications SAML authentication charge
express_signer_certificate DocuSign Express Certificate charge
personal_signer_certificate Personal Signer Certificate charge
safe_certificate SAFE BioPharma Signer Certificate charge
seats Included active seats charge
open_trust_certificate OpenTrust Signer Certificate charge

Request

HTTP request

GET /v2/accounts/{accountId}/billing_invoices/{invoiceId}

Parameters

Parameter name Value Description
Path parameters
accountId string

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

invoiceId string

Responses

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

SDK Method

Billing::getInvoice

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

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

{
"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

<billingInvoice 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<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>