Statement of Account

Output representation of the details of the generated account statement with async tracking details.

JSON Example 

This example shows a sample successful response.

1{
2  "requestIdentifier": "a0Bxx000000001ZEAQ",
3  "statusURL": "/services/data/v60.0/commerce/billing/document-generation-process/a0Bxx000000001ZEAQ/status",
4  "success": true,
5  "accountId": "001xx000003DGb2AAG",
6  "templateId": "0TRxx000000001XGAQ",
7  "errors": null
8}

This example shows a sample error response.

1{
2  "success": false,
3  "errors": [
4    {
5      "code": "ACCOUNT_NOT_FOUND",
6      "message": "Account with ID 001XX000004DKy5YAG not found",
7      "field": "accountId"
8    }
9  ]
10}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
accountIdStringPrimary account ID the statement is generated for.Big, 66.066.0
errorsError Response[]List of errors encountered during the processing of the API request.Big, 66.066.0
requestIdentifierStringUnique identifier for the request.Big, 66.066.0
statusURLStringStatus URL to track the operation.Big, 66.066.0
successBooleanIndicates whether the API request is successful (true) or not (false).Big, 66.066.0
templateIdStringDocument template ID that’s used to generate the PDF.Big, 66.066.0