Billing Platform API
API Reference (1.0)
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/CREDIT/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "CreditDate": "string", "Autoallocate": 0, "CreditNote": "string", "BillingProfileId": "string", "Created": "string", "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "VoidCreditId": 0, "VoidedCreditId": 0, "ApproveRejectedUser": 0, "ApprovedRejectedDate": "string", "ApprovalStatus": "string", "ApprovalNotes": "string", "AutoApproved": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "SourceRefundId": 0, "UnassignedCreditNote": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "TaxEngineRequestId": 0, "CreditType": "string", "AutoCreditTax": 0, "AutoCreditDiscount": 0, "AutoCreditAssociatedProduct": 0, "EcreditStatus": 0, "CreditCardName": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/CREDIT?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "CreditDate": "string", "Autoallocate": 0, "CreditNote": "string", "BillingProfileId": "string", "Created": "string", "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "VoidCreditId": 0, "VoidedCreditId": 0, "ApproveRejectedUser": 0, "ApprovedRejectedDate": "string", "ApprovalStatus": "string", "ApprovalNotes": "string", "AutoApproved": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "SourceRefundId": 0, "UnassignedCreditNote": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "TaxEngineRequestId": 0, "CreditType": "string", "AutoCreditTax": 0, "AutoCreditDiscount": 0, "AutoCreditAssociatedProduct": 0, "EcreditStatus": 0, "CreditCardName": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/CREDIT
https://my.billingplatform.com/demogm/rest/2.0/CREDIT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/CREDIT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string",
"CreditDate": "string",
"Autoallocate": 0,
"CreditNote": "string",
"BillingProfileId": "string",
"Created": "string",
"InvoiceIdDisplay": "string",
"UpdatedUserId": "string",
"CreatedUserId": "string",
"CreditCardExpDate": "string",
"CreditCardNumber": "string",
"CreditCardCCV": "string",
"InvoiceDetail": 0,
"VoidCreditId": 0,
"VoidedCreditId": 0,
"ApproveRejectedUser": 0,
"ApprovedRejectedDate": "string",
"ApprovalStatus": "string",
"ApprovalNotes": "string",
"AutoApproved": 0,
"ApprovalRejectedNote": "string",
"AccountProductId": 0,
"SourceRefundId": 0,
"UnassignedCreditNote": "string",
"VoidFlag": "string",
"AccountingPeriodId": 0,
"TaxEngineRequestId": 0,
"CreditType": "string",
"AutoCreditTax": 0,
"AutoCreditDiscount": 0,
"AutoCreditAssociatedProduct": 0,
"EcreditStatus": 0,
"CreditCardName": "string",
"Updated": "string"
}
}'
{ "retrieveResponse": { "Id": "string", "CreditDate": "string", "Autoallocate": 0, "CreditNote": "string", "BillingProfileId": "string", "Created": "string", "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "VoidCreditId": 0, "VoidedCreditId": 0, "ApproveRejectedUser": 0, "ApprovedRejectedDate": "string", "ApprovalStatus": "string", "ApprovalNotes": "string", "AutoApproved": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "SourceRefundId": 0, "UnassignedCreditNote": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "TaxEngineRequestId": 0, "CreditType": "string", "AutoCreditTax": 0, "AutoCreditDiscount": 0, "AutoCreditAssociatedProduct": 0, "EcreditStatus": 0, "CreditCardName": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/CREDIT/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "CreditDate": "string", "Autoallocate": 0, "CreditNote": "string", "BillingProfileId": "string", "Created": "string", "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "VoidCreditId": 0, "VoidedCreditId": 0, "ApproveRejectedUser": 0, "ApprovedRejectedDate": "string", "ApprovalStatus": "string", "ApprovalNotes": "string", "AutoApproved": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "SourceRefundId": 0, "UnassignedCreditNote": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "TaxEngineRequestId": 0, "CreditType": "string", "AutoCreditTax": 0, "AutoCreditDiscount": 0, "AutoCreditAssociatedProduct": 0, "EcreditStatus": 0, "CreditCardName": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/CREDIT?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "CreditDate": "string", "Autoallocate": 0, "CreditNote": "string", "BillingProfileId": "string", "Created": "string", "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "VoidCreditId": 0, "VoidedCreditId": 0, "ApproveRejectedUser": 0, "ApprovedRejectedDate": "string", "ApprovalStatus": "string", "ApprovalNotes": "string", "AutoApproved": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "SourceRefundId": 0, "UnassignedCreditNote": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "TaxEngineRequestId": 0, "CreditType": "string", "AutoCreditTax": 0, "AutoCreditDiscount": 0, "AutoCreditAssociatedProduct": 0, "EcreditStatus": 0, "CreditCardName": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/CREDIT
https://my.billingplatform.com/demogm/rest/2.0/CREDIT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/CREDIT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string",
"CreditDate": "string",
"Autoallocate": 0,
"CreditNote": "string",
"BillingProfileId": "string",
"Created": "string",
"InvoiceIdDisplay": "string",
"UpdatedUserId": "string",
"CreatedUserId": "string",
"CreditCardExpDate": "string",
"CreditCardNumber": "string",
"CreditCardCCV": "string",
"InvoiceDetail": 0,
"VoidCreditId": 0,
"VoidedCreditId": 0,
"ApproveRejectedUser": 0,
"ApprovedRejectedDate": "string",
"ApprovalStatus": "string",
"ApprovalNotes": "string",
"AutoApproved": 0,
"ApprovalRejectedNote": "string",
"AccountProductId": 0,
"SourceRefundId": 0,
"UnassignedCreditNote": "string",
"VoidFlag": "string",
"AccountingPeriodId": 0,
"TaxEngineRequestId": 0,
"CreditType": "string",
"AutoCreditTax": 0,
"AutoCreditDiscount": 0,
"AutoCreditAssociatedProduct": 0,
"EcreditStatus": 0,
"CreditCardName": "string",
"Updated": "string"
}
}'
{ "retrieveResponse": { "Id": "string", "CreditDate": "string", "Autoallocate": 0, "CreditNote": "string", "BillingProfileId": "string", "Created": "string", "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "VoidCreditId": 0, "VoidedCreditId": 0, "ApproveRejectedUser": 0, "ApprovedRejectedDate": "string", "ApprovalStatus": "string", "ApprovalNotes": "string", "AutoApproved": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "SourceRefundId": 0, "UnassignedCreditNote": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "TaxEngineRequestId": 0, "CreditType": "string", "AutoCreditTax": 0, "AutoCreditDiscount": 0, "AutoCreditAssociatedProduct": 0, "EcreditStatus": 0, "CreditCardName": "string", "Updated": "string" } }