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/GENERAL_LEDGER_TRANSACTION
https://my.billingplatform.com/demogm/rest/2.0/GENERAL_LEDGER_TRANSACTION
- 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/GENERAL_LEDGER_TRANSACTION?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "JEType": "string", "OriginRevenueContractId": 0, "OriginRevenueContractProductId": 0, "PrePeriodEnforceDate": "string", "JournalEntryId": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "InvoiceId": 0, "TransactionDate": "string", "Created": "string", "PaymentId": 0, "CreditId": 0, "Id": "string", "CurrencyCode": 0, "FinancialAccountId": 0, "TransactionId": "string", "Updated": "string", "FinancialCriteriaId": 0, "PeriodStartDate": "string", "PeriodEndDate": "string", "FinancialPeriodId": 0, "ReversalStatus": "string", "AccountingPeriodId": 0, "RevrecContractProductEventId": 0, "PerformanceObligation": 0, "RevRecContractProductId": 0, "FinancialAccountType": "string", "CatchUpAdjustmentFlag": "string", "PaymentItemInvoiceDetailId": 0, "CreditItemInvoiceDetailId": 0, "BillingActivityId": 0, "Source": "string", "EntityId": "string", "ObjectId": "string", "RefundId": 0, "AccountId": 0 } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/GENERAL_LEDGER_TRANSACTION
https://my.billingplatform.com/demogm/rest/2.0/GENERAL_LEDGER_TRANSACTION
- 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/GENERAL_LEDGER_TRANSACTION \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"JEType": "string",
"OriginRevenueContractId": 0,
"OriginRevenueContractProductId": 0,
"PrePeriodEnforceDate": "string",
"JournalEntryId": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"InvoiceId": 0,
"TransactionDate": "string",
"Created": "string",
"PaymentId": 0,
"CreditId": 0,
"Id": "string",
"CurrencyCode": 0,
"FinancialAccountId": 0,
"TransactionId": "string",
"Updated": "string",
"FinancialCriteriaId": 0,
"PeriodStartDate": "string",
"PeriodEndDate": "string",
"FinancialPeriodId": 0,
"ReversalStatus": "string",
"AccountingPeriodId": 0,
"RevrecContractProductEventId": 0,
"PerformanceObligation": 0,
"RevRecContractProductId": 0,
"FinancialAccountType": "string",
"CatchUpAdjustmentFlag": "string",
"PaymentItemInvoiceDetailId": 0,
"CreditItemInvoiceDetailId": 0,
"BillingActivityId": 0,
"Source": "string",
"EntityId": "string",
"ObjectId": "string",
"RefundId": 0,
"AccountId": 0
}
}'
{ "retrieveResponse": { "JEType": "string", "OriginRevenueContractId": 0, "OriginRevenueContractProductId": 0, "PrePeriodEnforceDate": "string", "JournalEntryId": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "InvoiceId": 0, "TransactionDate": "string", "Created": "string", "PaymentId": 0, "CreditId": 0, "Id": "string", "CurrencyCode": 0, "FinancialAccountId": 0, "TransactionId": "string", "Updated": "string", "FinancialCriteriaId": 0, "PeriodStartDate": "string", "PeriodEndDate": "string", "FinancialPeriodId": 0, "ReversalStatus": "string", "AccountingPeriodId": 0, "RevrecContractProductEventId": 0, "PerformanceObligation": 0, "RevRecContractProductId": 0, "FinancialAccountType": "string", "CatchUpAdjustmentFlag": "string", "PaymentItemInvoiceDetailId": 0, "CreditItemInvoiceDetailId": 0, "BillingActivityId": 0, "Source": "string", "EntityId": "string", "ObjectId": "string", "RefundId": 0, "AccountId": 0 } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/GENERAL_LEDGER_TRANSACTION
https://my.billingplatform.com/demogm/rest/2.0/GENERAL_LEDGER_TRANSACTION
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/GENERAL_LEDGER_TRANSACTION \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"JEType": "string",
"OriginRevenueContractId": 0,
"OriginRevenueContractProductId": 0,
"PrePeriodEnforceDate": "string",
"JournalEntryId": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"InvoiceId": 0,
"TransactionDate": "string",
"Created": "string",
"PaymentId": 0,
"CreditId": 0,
"Id": "string",
"CurrencyCode": 0,
"FinancialAccountId": 0,
"TransactionId": "string",
"Updated": "string",
"FinancialCriteriaId": 0,
"PeriodStartDate": "string",
"PeriodEndDate": "string",
"FinancialPeriodId": 0,
"ReversalStatus": "string",
"AccountingPeriodId": 0,
"RevrecContractProductEventId": 0,
"PerformanceObligation": 0,
"RevRecContractProductId": 0,
"FinancialAccountType": "string",
"CatchUpAdjustmentFlag": "string",
"PaymentItemInvoiceDetailId": 0,
"CreditItemInvoiceDetailId": 0,
"BillingActivityId": 0,
"Source": "string",
"EntityId": "string",
"ObjectId": "string",
"RefundId": 0,
"AccountId": 0
}
}'
{ "retrieveResponse": { "JEType": "string", "OriginRevenueContractId": 0, "OriginRevenueContractProductId": 0, "PrePeriodEnforceDate": "string", "JournalEntryId": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "InvoiceId": 0, "TransactionDate": "string", "Created": "string", "PaymentId": 0, "CreditId": 0, "Id": "string", "CurrencyCode": 0, "FinancialAccountId": 0, "TransactionId": "string", "Updated": "string", "FinancialCriteriaId": 0, "PeriodStartDate": "string", "PeriodEndDate": "string", "FinancialPeriodId": 0, "ReversalStatus": "string", "AccountingPeriodId": 0, "RevrecContractProductEventId": 0, "PerformanceObligation": 0, "RevRecContractProductId": 0, "FinancialAccountType": "string", "CatchUpAdjustmentFlag": "string", "PaymentItemInvoiceDetailId": 0, "CreditItemInvoiceDetailId": 0, "BillingActivityId": 0, "Source": "string", "EntityId": "string", "ObjectId": "string", "RefundId": 0, "AccountId": 0 } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/GENERAL_LEDGER_TRANSACTION
https://my.billingplatform.com/demogm/rest/2.0/GENERAL_LEDGER_TRANSACTION
- 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/GENERAL_LEDGER_TRANSACTION?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "JEType": "string", "OriginRevenueContractId": 0, "OriginRevenueContractProductId": 0, "PrePeriodEnforceDate": "string", "JournalEntryId": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "InvoiceId": 0, "TransactionDate": "string", "Created": "string", "PaymentId": 0, "CreditId": 0, "Id": "string", "CurrencyCode": 0, "FinancialAccountId": 0, "TransactionId": "string", "Updated": "string", "FinancialCriteriaId": 0, "PeriodStartDate": "string", "PeriodEndDate": "string", "FinancialPeriodId": 0, "ReversalStatus": "string", "AccountingPeriodId": 0, "RevrecContractProductEventId": 0, "PerformanceObligation": 0, "RevRecContractProductId": 0, "FinancialAccountType": "string", "CatchUpAdjustmentFlag": "string", "PaymentItemInvoiceDetailId": 0, "CreditItemInvoiceDetailId": 0, "BillingActivityId": 0, "Source": "string", "EntityId": "string", "ObjectId": "string", "RefundId": 0, "AccountId": 0 } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/GENERAL_LEDGER_TRANSACTION
https://my.billingplatform.com/demogm/rest/2.0/GENERAL_LEDGER_TRANSACTION
- 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/GENERAL_LEDGER_TRANSACTION \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"JEType": "string",
"OriginRevenueContractId": 0,
"OriginRevenueContractProductId": 0,
"PrePeriodEnforceDate": "string",
"JournalEntryId": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"InvoiceId": 0,
"TransactionDate": "string",
"Created": "string",
"PaymentId": 0,
"CreditId": 0,
"Id": "string",
"CurrencyCode": 0,
"FinancialAccountId": 0,
"TransactionId": "string",
"Updated": "string",
"FinancialCriteriaId": 0,
"PeriodStartDate": "string",
"PeriodEndDate": "string",
"FinancialPeriodId": 0,
"ReversalStatus": "string",
"AccountingPeriodId": 0,
"RevrecContractProductEventId": 0,
"PerformanceObligation": 0,
"RevRecContractProductId": 0,
"FinancialAccountType": "string",
"CatchUpAdjustmentFlag": "string",
"PaymentItemInvoiceDetailId": 0,
"CreditItemInvoiceDetailId": 0,
"BillingActivityId": 0,
"Source": "string",
"EntityId": "string",
"ObjectId": "string",
"RefundId": 0,
"AccountId": 0
}
}'
{ "retrieveResponse": { "JEType": "string", "OriginRevenueContractId": 0, "OriginRevenueContractProductId": 0, "PrePeriodEnforceDate": "string", "JournalEntryId": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "InvoiceId": 0, "TransactionDate": "string", "Created": "string", "PaymentId": 0, "CreditId": 0, "Id": "string", "CurrencyCode": 0, "FinancialAccountId": 0, "TransactionId": "string", "Updated": "string", "FinancialCriteriaId": 0, "PeriodStartDate": "string", "PeriodEndDate": "string", "FinancialPeriodId": 0, "ReversalStatus": "string", "AccountingPeriodId": 0, "RevrecContractProductEventId": 0, "PerformanceObligation": 0, "RevRecContractProductId": 0, "FinancialAccountType": "string", "CatchUpAdjustmentFlag": "string", "PaymentItemInvoiceDetailId": 0, "CreditItemInvoiceDetailId": 0, "BillingActivityId": 0, "Source": "string", "EntityId": "string", "ObjectId": "string", "RefundId": 0, "AccountId": 0 } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/GENERAL_LEDGER_TRANSACTION
https://my.billingplatform.com/demogm/rest/2.0/GENERAL_LEDGER_TRANSACTION
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/GENERAL_LEDGER_TRANSACTION \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"JEType": "string",
"OriginRevenueContractId": 0,
"OriginRevenueContractProductId": 0,
"PrePeriodEnforceDate": "string",
"JournalEntryId": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"InvoiceId": 0,
"TransactionDate": "string",
"Created": "string",
"PaymentId": 0,
"CreditId": 0,
"Id": "string",
"CurrencyCode": 0,
"FinancialAccountId": 0,
"TransactionId": "string",
"Updated": "string",
"FinancialCriteriaId": 0,
"PeriodStartDate": "string",
"PeriodEndDate": "string",
"FinancialPeriodId": 0,
"ReversalStatus": "string",
"AccountingPeriodId": 0,
"RevrecContractProductEventId": 0,
"PerformanceObligation": 0,
"RevRecContractProductId": 0,
"FinancialAccountType": "string",
"CatchUpAdjustmentFlag": "string",
"PaymentItemInvoiceDetailId": 0,
"CreditItemInvoiceDetailId": 0,
"BillingActivityId": 0,
"Source": "string",
"EntityId": "string",
"ObjectId": "string",
"RefundId": 0,
"AccountId": 0
}
}'
{ "retrieveResponse": { "JEType": "string", "OriginRevenueContractId": 0, "OriginRevenueContractProductId": 0, "PrePeriodEnforceDate": "string", "JournalEntryId": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "InvoiceId": 0, "TransactionDate": "string", "Created": "string", "PaymentId": 0, "CreditId": 0, "Id": "string", "CurrencyCode": 0, "FinancialAccountId": 0, "TransactionId": "string", "Updated": "string", "FinancialCriteriaId": 0, "PeriodStartDate": "string", "PeriodEndDate": "string", "FinancialPeriodId": 0, "ReversalStatus": "string", "AccountingPeriodId": 0, "RevrecContractProductEventId": 0, "PerformanceObligation": 0, "RevRecContractProductId": 0, "FinancialAccountType": "string", "CatchUpAdjustmentFlag": "string", "PaymentItemInvoiceDetailId": 0, "CreditItemInvoiceDetailId": 0, "BillingActivityId": 0, "Source": "string", "EntityId": "string", "ObjectId": "string", "RefundId": 0, "AccountId": 0 } }