Table 4. API Resources for Statements
|
|
|
|
GET |
/statements/ |
accountKey |
Returns a list of statements available for the account, including statement date and statement number. |
GET |
/statements/latest |
accountKey |
Returns the latest statement summary for the account. |
GET |
/statements/{statementKey}/summary |
accountKey, reportPeriodKey |
Returns a statement summary. |
GET |
/statements/{statementKey}/accountSummary |
accountKey, reportPeriodKey |
Returns a summary for an account on a statement, including a list of service numbers. |
GET |
/statements/{statementKey}/serviceAgreements/{serviceKey}/summary |
accountKey, reportPeriodKey |
Returns a summary of a service for account on a statement. |
GET |
/statements/{statementKey}/serviceAgreements/{serviceKey}/usage |
accountKey, reportPeriodKey |
Returns a statement usage summary. |
GET |
/statements/{statementKey}/serviceAgreements/{serviceKey}/usageDetails |
accountKey, reportPeriodKey |
Returns a summary of statement usage detail. |
GET |
/statements/{statementKey}/serviceAgreements/{serviceKey}/transactionDetails |
serviceDetailKey |
Returns the statement transaction details for a particular service agreement. The serviceKey can be retrieved from a call to the /statements/{statementKey}/accountSummary resource. |
GET |
/statements/{statementKey}/contentRefs |
None |
Returns a list of content IDs for the statement. |
POST |
/statements/{statementKey}/contentRefs |
None |
Adds a PDF reference to the statement, in which the contentRef is the ID for the PDF on the content management server. This resource can also add for DAISY and BRAILLE, content ID is in the payload. |