Table 3. API Resources for Statements
|
|
Additional Input Parameters |
|
GET |
/statements/{account_id}/latest |
None |
Returns the latest statement summary for the account, in which account_id is the unique account identifier, and it is the concatenation of biller id and account number, for example, BS1%7C7836380DEMO1. |
GET |
/statements/{account_id}/ |
None |
Returns the list of statements available for the account, including the statement date and number. |
GET |
/statements/{statement_key}/summary |
accountKey, reportPeriodStart |
Returns the statement summary, in which the statement key is an internal key for the statement object, which can be available from calls to the /statements/{account_id}/latest, or /statement/{account_id} resources. |
GET |
/statements/{statement_key}/account_summary |
accountKey, reportPeriodStart |
Returns the summary for an account within a statement, in which the statement key is an internal key for the statement object, which can be available from calls to the /statements/{account_id}/latest, or /statement/{account_id} resources. |
GET |
/statements/{statement_key}/service_agreements/{service_key}/summary |
accountKey, reportPeriodStart |
Returns the summary of a service within a statement. Service_key can be retrieved from a call to the /statements/{statement_key}/account_summary resource. |
GET |
/statements/{statement_key}/service_agreements/{service_key}/usage |
accountKey, reportPeriodStart |
Returns the statement usage summary for a particular service agreement. Service_key can be retrieved from a call to the /statements/{statement_key}/account_summary resource. |
GET |
/statements/{statement_key}/service_agreements/{service_key}/usage_details |
accountKey, reportPeriodStart |
Returns the statement usage details for a particular service agreement. Service_key can be retrieved from a call to the /statements/{statement_key}/account_summary resource. |
GET |
/statements/{statement_key}/service_agreements/{service_key}/transaction_details |
serviceDetailKey |
Returns the statement transaction details for a particular service agreement. Service_key can be retrieved from a call to the /statements/{statement_key}/account_summary resource. |
POST |
/statements/{statement_key}/contentRefs |
None |
Adds a PDF reference to the statement, in which the contentRef is the ID for the PDF on the content management server. |
GET |
/statements/{statement_key}/contentRefs |
None |
Returns a list of content IDs for the statement. |