Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/STATEMENT_TEMPLATE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/STATEMENT_TEMPLATE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/STATEMENT_TEMPLATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" } }'
{ "retrieveResponse": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/STATEMENT_TEMPLATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" } }'
{ "retrieveResponse": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/STATEMENT_TEMPLATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" }, "externalIDFieldName": "StatementTemplateName" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/STATEMENT_TEMPLATE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "ShowCreditAdjDetail": 0, "ShowPastDueStatements": 0, "PreviewXsd": "string", "SupportNumber": "string", "StatementTemplateName": "string", "SupportMessage1": "string", "StatementXslId": "string", "LanguageCode": "string", "DefaultFlag": 0, "ShowTaxFeeDetail": 0, "EbppUrl": "string", "EmailTemplateId": "string", "Status": "string", "ShowAging": 0, "SupportMessage": "string", "FileStorageId": "string", "Id": "string", "AccountId": "string", "LogoFilePath": "string", "SystemLogoFileName": "string", "Type": "string", "DateFormat": "string", "Created": "string", "Updated": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "BaseEntityId": "string" } }