API Reference (1.0)
Billing Platform API
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT/{id}
https://my.billingplatform.com/demogm/rest/2.0/CREDIT/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountProductId": null, "AccountingPeriodId": null, "ApprovalNotes": null, "ApprovalRejectedNote": null, "ApprovalStatus": null, "ApproveRejectedUser": null, "ApprovedRejectedDate": null, "AutoApproved": null, "AutoCreditAssociatedProduct": null, "AutoCreditDiscount": null, "AutoCreditTax": null, "Autoallocate": null, "BillingProfileId": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditDate": null, "CreditNote": null, "CreditType": null, "EcreditStatus": null, "Id": null, "InvoiceDetail": null, "InvoiceIdDisplay": null, "SourceRefundId": null, "TaxEngineRequestId": null, "UnassignedCreditNote": null, "Updated": null, "UpdatedUserId": null, "VoidCreditId": null, "VoidFlag": null, "VoidedCreditId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT
https://my.billingplatform.com/demogm/rest/2.0/CREDIT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountProductId": null, "AccountingPeriodId": null, "ApprovalNotes": null, "ApprovalRejectedNote": null, "ApprovalStatus": null, "ApproveRejectedUser": null, "ApprovedRejectedDate": null, "AutoApproved": null, "AutoCreditAssociatedProduct": null, "AutoCreditDiscount": null, "AutoCreditTax": null, "Autoallocate": null, "BillingProfileId": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditDate": null, "CreditNote": null, "CreditType": null, "EcreditStatus": null, "Id": null, "InvoiceDetail": null, "InvoiceIdDisplay": null, "SourceRefundId": null, "TaxEngineRequestId": null, "UnassignedCreditNote": null, "Updated": null, "UpdatedUserId": null, "VoidCreditId": null, "VoidFlag": null, "VoidedCreditId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT
https://my.billingplatform.com/demogm/rest/2.0/CREDIT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountProductId": null,
"AccountingPeriodId": null,
"ApprovalNotes": null,
"ApprovalRejectedNote": null,
"ApprovalStatus": null,
"ApproveRejectedUser": null,
"ApprovedRejectedDate": null,
"AutoApproved": null,
"AutoCreditAssociatedProduct": null,
"AutoCreditDiscount": null,
"AutoCreditTax": null,
"Autoallocate": null,
"BillingProfileId": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditDate": null,
"CreditNote": null,
"CreditType": null,
"EcreditStatus": null,
"Id": null,
"InvoiceDetail": null,
"InvoiceIdDisplay": null,
"SourceRefundId": null,
"TaxEngineRequestId": null,
"UnassignedCreditNote": null,
"Updated": null,
"UpdatedUserId": null,
"VoidCreditId": null,
"VoidFlag": null,
"VoidedCreditId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT/{id}
https://my.billingplatform.com/demogm/rest/2.0/CREDIT/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountProductId": null, "AccountingPeriodId": null, "ApprovalNotes": null, "ApprovalRejectedNote": null, "ApprovalStatus": null, "ApproveRejectedUser": null, "ApprovedRejectedDate": null, "AutoApproved": null, "AutoCreditAssociatedProduct": null, "AutoCreditDiscount": null, "AutoCreditTax": null, "Autoallocate": null, "BillingProfileId": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditDate": null, "CreditNote": null, "CreditType": null, "EcreditStatus": null, "Id": null, "InvoiceDetail": null, "InvoiceIdDisplay": null, "SourceRefundId": null, "TaxEngineRequestId": null, "UnassignedCreditNote": null, "Updated": null, "UpdatedUserId": null, "VoidCreditId": null, "VoidFlag": null, "VoidedCreditId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT
https://my.billingplatform.com/demogm/rest/2.0/CREDIT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountProductId": null, "AccountingPeriodId": null, "ApprovalNotes": null, "ApprovalRejectedNote": null, "ApprovalStatus": null, "ApproveRejectedUser": null, "ApprovedRejectedDate": null, "AutoApproved": null, "AutoCreditAssociatedProduct": null, "AutoCreditDiscount": null, "AutoCreditTax": null, "Autoallocate": null, "BillingProfileId": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditDate": null, "CreditNote": null, "CreditType": null, "EcreditStatus": null, "Id": null, "InvoiceDetail": null, "InvoiceIdDisplay": null, "SourceRefundId": null, "TaxEngineRequestId": null, "UnassignedCreditNote": null, "Updated": null, "UpdatedUserId": null, "VoidCreditId": null, "VoidFlag": null, "VoidedCreditId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT
https://my.billingplatform.com/demogm/rest/2.0/CREDIT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/CREDIT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountProductId": null,
"AccountingPeriodId": null,
"ApprovalNotes": null,
"ApprovalRejectedNote": null,
"ApprovalStatus": null,
"ApproveRejectedUser": null,
"ApprovedRejectedDate": null,
"AutoApproved": null,
"AutoCreditAssociatedProduct": null,
"AutoCreditDiscount": null,
"AutoCreditTax": null,
"Autoallocate": null,
"BillingProfileId": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditDate": null,
"CreditNote": null,
"CreditType": null,
"EcreditStatus": null,
"Id": null,
"InvoiceDetail": null,
"InvoiceIdDisplay": null,
"SourceRefundId": null,
"TaxEngineRequestId": null,
"UnassignedCreditNote": null,
"Updated": null,
"UpdatedUserId": null,
"VoidCreditId": null,
"VoidFlag": null,
"VoidedCreditId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }