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/INVOICE
https://my.billingplatform.com/demogm/rest/2.0/INVOICE
- 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/INVOICE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountStrategyId": null, "AccountingPeriodId": null, "ActivityEndDate": null, "ActivityStartDate": null, "AgingInterval": null, "ApprovalDate": null, "ApprovalStatus": null, "ApprovalUserId": null, "AutoPayTriggerDate": null, "AvailableActions": null, "BillableFlag": null, "BillingCycleEndDate": null, "BillingCycleStartDate": null, "BillingProfileId": null, "ClosedDate": null, "Created": null, "CreatedByInvoiceId": null, "CreatedUserId": null, "CurrentAction": null, "Disputed": null, "DueDate": null, "EinvoiceStatus": null, "EstimateDate": null, "EstimatedStatus": null, "EventInvoiceCycleId": null, "FileName": null, "Id": null, "InvoiceReburnAction": null, "LastAction": null, "LastEmailDeliveryDate": null, "LastGatewayKey": null, "ManualCloseApprovedFlag": null, "MassUpdateError": null, "MigratedInvoice": null, "MoveInvoiceDescription": null, "NextEstimateDate": null, "PaymentStatus": null, "PdfCreatedDate": null, "PendingActions": null, "ReburnFlag": null, "ReopenedByInvoiceId": null, "SendInvoiceEmail": null, "Status": null, "SuppressBulkCloseFlag": null, "Updated": null, "UpdatedUserId": null, "VoidFlag": null, "VoidedByCreditId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/INVOICE
https://my.billingplatform.com/demogm/rest/2.0/INVOICE
- 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/INVOICE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountStrategyId": null,
"AccountingPeriodId": null,
"ActivityEndDate": null,
"ActivityStartDate": null,
"AgingInterval": null,
"ApprovalDate": null,
"ApprovalStatus": null,
"ApprovalUserId": null,
"AutoPayTriggerDate": null,
"AvailableActions": null,
"BillableFlag": null,
"BillingCycleEndDate": null,
"BillingCycleStartDate": null,
"BillingProfileId": null,
"ClosedDate": null,
"Created": null,
"CreatedByInvoiceId": null,
"CreatedUserId": null,
"CurrentAction": null,
"Disputed": null,
"DueDate": null,
"EinvoiceStatus": null,
"EstimateDate": null,
"EstimatedStatus": null,
"EventInvoiceCycleId": null,
"FileName": null,
"Id": null,
"InvoiceReburnAction": null,
"LastAction": null,
"LastEmailDeliveryDate": null,
"LastGatewayKey": null,
"ManualCloseApprovedFlag": null,
"MassUpdateError": null,
"MigratedInvoice": null,
"MoveInvoiceDescription": null,
"NextEstimateDate": null,
"PaymentStatus": null,
"PdfCreatedDate": null,
"PendingActions": null,
"ReburnFlag": null,
"ReopenedByInvoiceId": null,
"SendInvoiceEmail": null,
"Status": null,
"SuppressBulkCloseFlag": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidedByCreditId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/INVOICE
https://my.billingplatform.com/demogm/rest/2.0/INVOICE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/INVOICE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountStrategyId": null,
"AccountingPeriodId": null,
"ActivityEndDate": null,
"ActivityStartDate": null,
"AgingInterval": null,
"ApprovalDate": null,
"ApprovalStatus": null,
"ApprovalUserId": null,
"AutoPayTriggerDate": null,
"AvailableActions": null,
"BillableFlag": null,
"BillingCycleEndDate": null,
"BillingCycleStartDate": null,
"BillingProfileId": null,
"ClosedDate": null,
"Created": null,
"CreatedByInvoiceId": null,
"CreatedUserId": null,
"CurrentAction": null,
"Disputed": null,
"DueDate": null,
"EinvoiceStatus": null,
"EstimateDate": null,
"EstimatedStatus": null,
"EventInvoiceCycleId": null,
"FileName": null,
"Id": null,
"InvoiceReburnAction": null,
"LastAction": null,
"LastEmailDeliveryDate": null,
"LastGatewayKey": null,
"ManualCloseApprovedFlag": null,
"MassUpdateError": null,
"MigratedInvoice": null,
"MoveInvoiceDescription": null,
"NextEstimateDate": null,
"PaymentStatus": null,
"PdfCreatedDate": null,
"PendingActions": null,
"ReburnFlag": null,
"ReopenedByInvoiceId": null,
"SendInvoiceEmail": null,
"Status": null,
"SuppressBulkCloseFlag": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidedByCreditId": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/INVOICE
https://my.billingplatform.com/demogm/rest/2.0/INVOICE
- 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/INVOICE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "AccountStrategyId": null, "AccountingPeriodId": null, "ActivityEndDate": null, "ActivityStartDate": null, "AgingInterval": null, "ApprovalDate": null, "ApprovalStatus": null, "ApprovalUserId": null, "AutoPayTriggerDate": null, "AvailableActions": null, "BillableFlag": null, "BillingCycleEndDate": null, "BillingCycleStartDate": null, "BillingProfileId": null, "ClosedDate": null, "Created": null, "CreatedByInvoiceId": null, "CreatedUserId": null, "CurrentAction": null, "Disputed": null, "DueDate": null, "EinvoiceStatus": null, "EstimateDate": null, "EstimatedStatus": null, "EventInvoiceCycleId": null, "FileName": null, "Id": null, "InvoiceReburnAction": null, "LastAction": null, "LastEmailDeliveryDate": null, "LastGatewayKey": null, "ManualCloseApprovedFlag": null, "MassUpdateError": null, "MigratedInvoice": null, "MoveInvoiceDescription": null, "NextEstimateDate": null, "PaymentStatus": null, "PdfCreatedDate": null, "PendingActions": null, "ReburnFlag": null, "ReopenedByInvoiceId": null, "SendInvoiceEmail": null, "Status": null, "SuppressBulkCloseFlag": null, "Updated": null, "UpdatedUserId": null, "VoidFlag": null, "VoidedByCreditId": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/INVOICE
https://my.billingplatform.com/demogm/rest/2.0/INVOICE
- 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/INVOICE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountStrategyId": null,
"AccountingPeriodId": null,
"ActivityEndDate": null,
"ActivityStartDate": null,
"AgingInterval": null,
"ApprovalDate": null,
"ApprovalStatus": null,
"ApprovalUserId": null,
"AutoPayTriggerDate": null,
"AvailableActions": null,
"BillableFlag": null,
"BillingCycleEndDate": null,
"BillingCycleStartDate": null,
"BillingProfileId": null,
"ClosedDate": null,
"Created": null,
"CreatedByInvoiceId": null,
"CreatedUserId": null,
"CurrentAction": null,
"Disputed": null,
"DueDate": null,
"EinvoiceStatus": null,
"EstimateDate": null,
"EstimatedStatus": null,
"EventInvoiceCycleId": null,
"FileName": null,
"Id": null,
"InvoiceReburnAction": null,
"LastAction": null,
"LastEmailDeliveryDate": null,
"LastGatewayKey": null,
"ManualCloseApprovedFlag": null,
"MassUpdateError": null,
"MigratedInvoice": null,
"MoveInvoiceDescription": null,
"NextEstimateDate": null,
"PaymentStatus": null,
"PdfCreatedDate": null,
"PendingActions": null,
"ReburnFlag": null,
"ReopenedByInvoiceId": null,
"SendInvoiceEmail": null,
"Status": null,
"SuppressBulkCloseFlag": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidedByCreditId": null
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/INVOICE
https://my.billingplatform.com/demogm/rest/2.0/INVOICE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/INVOICE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountStrategyId": null,
"AccountingPeriodId": null,
"ActivityEndDate": null,
"ActivityStartDate": null,
"AgingInterval": null,
"ApprovalDate": null,
"ApprovalStatus": null,
"ApprovalUserId": null,
"AutoPayTriggerDate": null,
"AvailableActions": null,
"BillableFlag": null,
"BillingCycleEndDate": null,
"BillingCycleStartDate": null,
"BillingProfileId": null,
"ClosedDate": null,
"Created": null,
"CreatedByInvoiceId": null,
"CreatedUserId": null,
"CurrentAction": null,
"Disputed": null,
"DueDate": null,
"EinvoiceStatus": null,
"EstimateDate": null,
"EstimatedStatus": null,
"EventInvoiceCycleId": null,
"FileName": null,
"Id": null,
"InvoiceReburnAction": null,
"LastAction": null,
"LastEmailDeliveryDate": null,
"LastGatewayKey": null,
"ManualCloseApprovedFlag": null,
"MassUpdateError": null,
"MigratedInvoice": null,
"MoveInvoiceDescription": null,
"NextEstimateDate": null,
"PaymentStatus": null,
"PdfCreatedDate": null,
"PendingActions": null,
"ReburnFlag": null,
"ReopenedByInvoiceId": null,
"SendInvoiceEmail": null,
"Status": null,
"SuppressBulkCloseFlag": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidedByCreditId": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }