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