Skip to main content

Summary Statement Settings

Zuora

  • 日本語のコンテンツは機械翻訳されており、補助的な参照を目的としています。機械翻訳の精度は保証できません。英語版が正となります。また、現時点では検索機能は日本語での検索をサポートしていません。翻訳に関するフィードバックについては、docs@zuora.comに送信してください。

Summary Statement Settings

  1. Last updated
    Oct 15, 2024
  2. Save as PDF

Describes how to retrieve, update, and delete Summary Statements through the Settings API.

Get a specific summary statement template

To get a specific template for a summary statement, see the following request and a sample 200 response.

HTTP request:

GET  https://rest.zuora.com/settings/summary-statement-templates/{templateKey}

The request parameter for this request is as follows:

  • templateKey - The template ID or template number

Response body:

view sourceprint?
01{
02   "name": "summaryStatementTemplate2",
03   "defaultTemplate": false,
04   "base64EncodedTemplateFileContent": "eyJodG1sQ29udGVudCI6ICI8cD5BY2NvdW50TnVtYmVyOnt7U3VtbWFyeVN0YXRlbWVudC5BY2NvdW50LkFjY291bnROdW1iZXJ9fTwvcD48cD5TdGF0ZW1lbnROdW1iZXI6e3tTdW1tYXJ5U3RhdGVtZW50LlN0YXRlbWVudE51bWJlcn19PC9wPiJ9",
05   "templateFormat": "HTML",
06   "associatedToBillingAccount": false,
07   "templateNumber": "SSTEMP-00000002",
08   "id": "40288186916939740191697fc3b206c6",
09   "updatedOn": "2024-08-19T00:22:41.000-07:00"
10}

Get all templates for summary statement

To get all templates for a summary statement, see the following request and a sample 200 response.

HTTP request:

GET https://rest.zuora.com/settings/summary-statement-templates

The request parameter for this request is as follows:

  • templateKey - The template ID or template number

Response body:

view sourceprint?
01[
02   {
03       "name": "summaryStatementTemplate2",
04       "defaultTemplate": false,
05       "templateFormat": "HTML",
06       "associatedToBillingAccount": false,
07       "templateNumber": "SSTEMP-00000002",
08       "id": "40288186916939740191697fc3b206c6",
09       "updatedOn": "2024-08-19T00:22:41.000-07:00"
10   },
11   {
12       "name": "summaryStatementTemplate3",
13       "defaultTemplate": true,
14       "templateFormat": "HTML",
15       "associatedToBillingAccount": false,
16       "templateNumber": "SSTEMP-00000003",
17       "id": "40288186916939740191698442b206d8",
18       "updatedOn": "2024-08-19T00:22:41.000-07:00"
19   }
20]

Create a new summary statement template

To create a template for a summary statement, see the following request and a sample 200 response.

HTTP request:

POST https://rest.zuora.com/settings/summary-statement-templates

Request parameters:

  • name - The name of the summary statement template.
  • templateFormat - The format of the template. Currently, only 'HTML' is supported.
  • defaultTemplate - Indicates whether this template is the default template.
  • base64EncodedTemplateFileContent - The content of the template encoded using the Base64 algorithm. This allows for safe transmission of binary data in a text format.

Request body:

view sourceprint?
1{
2   "name": "summaryStatementTemplate3",
3   "templateFormat": "HTML",
4   "defaultTemplate": true,
5   "base64EncodedTemplateFileContent": "eyJodG1sQ29udGVudCI6ICI8cD5BY2NvdW50TnVtYmVyOnt7U3VtbWFyeVN0YXRlbWVudC5BY2NvdW50LkFjY291bnROdW1iZXJ9fTwvcD48cD5TdGF0ZW1lbnROdW1iZXI6e3tTdW1tYXJ5U3RhdGVtZW50LlN0YXRlbWVudE51bWJlcn19PC9wPiJ9"
6}

Response body:

view sourceprint?
01{
02   "name": "summaryStatementTemplate4",
03   "defaultTemplate": true,
04   "base64EncodedTemplateFileContent": "eyJodG1sQ29udGVudCI6ICI8cD5BY2NvdW50TnVtYmVyOnt7U3VtbWFyeVN0YXRlbWVudC5BY2NvdW50LkFjY291bnROdW1iZXJ9fTwvcD48cD5TdGF0ZW1lbnROdW1iZXI6e3tTdW1tYXJ5U3RhdGVtZW50LlN0YXRlbWVudE51bWJlcn19PC9wPiJ9",
05   "templateFormat": "HTML",
06   "associatedToBillingAccount": false,
07   "templateNumber": "SSTEMP-00000004",
08   "id": "402881869169397401916dc2848b1aa2",
09   "updatedOn": "2024-08-19T20:09:10.158-07:00"
10}

Update a specific summary statement template

To update a template for a summary statement, see the following request and a sample 200 response.

HTTP request:

PUT https://rest.zuora.com/settings/summary-statement-templates/{templateKey}

Request parameters:

  • name - The name of the summary statement template.
  • templateFormat - The format of the template. Currently, only 'HTML' is supported.
  • defaultTemplate - Indicates whether this template is the default template.
  • base64EncodedTemplateFileContent - The content of the template encoded using the Base64 algorithm. This allows for safe transmission of binary data in a text format.

Request body:

view sourceprint?
1{
2   "name": "summaryStatementTemplate2",
3   "templateFormat": "HTML",
4   "defaultTemplate": true,
5   "base64EncodedTemplateFileContent": "eyJodG1sQ29udGVudCI6ICI8cD5BY2NvdW50TnVtYmVyOnt7U3VtbWFyeVN0YXRlbWVudC5BY2NvdW50LkFjY291bnROdW1iZXJ9fTwvcD48cD5TdGF0ZW1lbnROdW1iZXI6e3tTdW1tYXJ5U3RhdGVtZW50LlN0YXRlbWVudE51bWJlcn19PC9wPiJ9"
6}

Response body:

view sourceprint?
01{
02   "name": "summaryStatementTemplate2",
03   "defaultTemplate": false,
04   "base64EncodedTemplateFileContent": "eyJodG1sQ29udGVudCI6ICI8cD5BY2NvdW50TnVtYmVyOnt7U3VtbWFyeVN0YXRlbWVudC5BY2NvdW50LkFjY291bnROdW1iZXJ9fTwvcD48cD5TdGF0ZW1lbnROdW1iZXI6e3tTdW1tYXJ5U3RhdGVtZW50LlN0YXRlbWVudE51bWJlcn19PC9wPiJ9",
05   "templateFormat": "HTML",
06   "associatedToBillingAccount": false,
07   "templateNumber": "SSTEMP-00000002",
08   "id": "40288186916939740191697fc3b206c6",
09   "updatedOn": "2024-08-19T20:14:33.852-07:00"
10}

Delete a specific summary statement template

To delete a specific summary statement template, the template key of the summary statement is required as a path parameter. See the following request and a sample of 200 response.

HTTP request:

DELETE  https://rest.zuora.com/settings/summary-statement-templates/{templateKey}

Response body: 

view sourceprint?
1{
2    "success": true
3}