Billing Platform API
Billing Platform API
An Account is a fundamental entity used for billing customers. It plays a crucial role in various billing and invoicing processes. Each Account is associated with an Account Type, Activity Time Zone, and Country. The AllowPricingInDifferentCurrency field determines if pricing can be in a currency different from the default. The Account can be linked to other entities such as Billable Account, Billing Profile, Collector User, and Parent Account. The Billable Account and Billing Profile are essential for invoicing and payment information. The Collector User field identifies the user responsible for collecting payments.
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "Updated": "string", "UpdateError": "string", "MDLEventId": 0, "Created": "string", "AccountId": 0, "ProductId": 0, "Id": "string", "AccountProductId": 0, "ActivityDate": "string", "DiscountedBy": 0, "RatedAmount": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "SubscriptionFromDate": "string", "StandardCostUnrounded": "string", "RateDate": "string", "ReprocessQueueID": 0, "Formula": "string", "Quantity": "string", "ProcessStatus": "string", "ProcessDescription": "string", "InvoiceId": 0, "BillingIdentifierId": "string", "ManualChargeByUserId": "string", "CountryCodeMapId": "string", "CollectorStageId": "string", "ActivityCollectorId": "string", "Feature": "string", "EventInvoiceCycleId": "string", "ContractId": "string", "ContractRateId": "string", "MinChargeFlag": "string", "DestinationCountryCodeId": 0, "OriginationCountryCodeId": 0, "CurrencyCode": 0, "PackageProductId": "string", "ProrateFactor": "string", "UpperBand": "string", "AccumulatorValueId": 0, "RatingMethodId": 0, "ExchangeRateId": 0, "PricingCurrencyCode": 0, "SplitFromBillActId": 0, "DiscountActivityId": 0, "AccountPackageId": 0, "BillingIdentifierAccountProductId": 0, "TieredGroup": "string", "RateSource": "string", "AvalaraGroupKey": "string", "CostUnrounded": "string", "TaxCostUnrounded": "string", "PricingId": "string", "RateClassProductId": "string", "Estimated": 0, "SubscriptionToDate": "string", "RatingDate": "string", "EffectiveRated": 0 } }
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "Updated": "string", "UpdateError": "string", "MDLEventId": 0, "Created": "string", "AccountId": 0, "ProductId": 0, "Id": "string", "AccountProductId": 0, "ActivityDate": "string", "DiscountedBy": 0, "RatedAmount": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "SubscriptionFromDate": "string", "StandardCostUnrounded": "string", "RateDate": "string", "ReprocessQueueID": 0, "Formula": "string", "Quantity": "string", "ProcessStatus": "string", "ProcessDescription": "string", "InvoiceId": 0, "BillingIdentifierId": "string", "ManualChargeByUserId": "string", "CountryCodeMapId": "string", "CollectorStageId": "string", "ActivityCollectorId": "string", "Feature": "string", "EventInvoiceCycleId": "string", "ContractId": "string", "ContractRateId": "string", "MinChargeFlag": "string", "DestinationCountryCodeId": 0, "OriginationCountryCodeId": 0, "CurrencyCode": 0, "PackageProductId": "string", "ProrateFactor": "string", "UpperBand": "string", "AccumulatorValueId": 0, "RatingMethodId": 0, "ExchangeRateId": 0, "PricingCurrencyCode": 0, "SplitFromBillActId": 0, "DiscountActivityId": 0, "AccountPackageId": 0, "BillingIdentifierAccountProductId": 0, "TieredGroup": "string", "RateSource": "string", "AvalaraGroupKey": "string", "CostUnrounded": "string", "TaxCostUnrounded": "string", "PricingId": "string", "RateClassProductId": "string", "Estimated": 0, "SubscriptionToDate": "string", "RatingDate": "string", "EffectiveRated": 0 } }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"UpdateError": "string",
"MDLEventId": 0,
"Created": "string",
"AccountId": 0,
"ProductId": 0,
"Id": "string",
"AccountProductId": 0,
"ActivityDate": "string",
"DiscountedBy": 0,
"RatedAmount": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"SubscriptionFromDate": "string",
"StandardCostUnrounded": "string",
"RateDate": "string",
"ReprocessQueueID": 0,
"Formula": "string",
"Quantity": "string",
"ProcessStatus": "string",
"ProcessDescription": "string",
"InvoiceId": 0,
"BillingIdentifierId": "string",
"ManualChargeByUserId": "string",
"CountryCodeMapId": "string",
"CollectorStageId": "string",
"ActivityCollectorId": "string",
"Feature": "string",
"EventInvoiceCycleId": "string",
"ContractId": "string",
"ContractRateId": "string",
"MinChargeFlag": "string",
"DestinationCountryCodeId": 0,
"OriginationCountryCodeId": 0,
"CurrencyCode": 0,
"PackageProductId": "string",
"ProrateFactor": "string",
"UpperBand": "string",
"AccumulatorValueId": 0,
"RatingMethodId": 0,
"ExchangeRateId": 0,
"PricingCurrencyCode": 0,
"SplitFromBillActId": 0,
"DiscountActivityId": 0,
"AccountPackageId": 0,
"BillingIdentifierAccountProductId": 0,
"TieredGroup": "string",
"RateSource": "string",
"AvalaraGroupKey": "string",
"CostUnrounded": "string",
"TaxCostUnrounded": "string",
"PricingId": "string",
"RateClassProductId": "string",
"Estimated": 0,
"SubscriptionToDate": "string",
"RatingDate": "string",
"EffectiveRated": 0
}
}'{ "retrieveResponse": { "Updated": "string", "UpdateError": "string", "MDLEventId": 0, "Created": "string", "AccountId": 0, "ProductId": 0, "Id": "string", "AccountProductId": 0, "ActivityDate": "string", "DiscountedBy": 0, "RatedAmount": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "SubscriptionFromDate": "string", "StandardCostUnrounded": "string", "RateDate": "string", "ReprocessQueueID": 0, "Formula": "string", "Quantity": "string", "ProcessStatus": "string", "ProcessDescription": "string", "InvoiceId": 0, "BillingIdentifierId": "string", "ManualChargeByUserId": "string", "CountryCodeMapId": "string", "CollectorStageId": "string", "ActivityCollectorId": "string", "Feature": "string", "EventInvoiceCycleId": "string", "ContractId": "string", "ContractRateId": "string", "MinChargeFlag": "string", "DestinationCountryCodeId": 0, "OriginationCountryCodeId": 0, "CurrencyCode": 0, "PackageProductId": "string", "ProrateFactor": "string", "UpperBand": "string", "AccumulatorValueId": 0, "RatingMethodId": 0, "ExchangeRateId": 0, "PricingCurrencyCode": 0, "SplitFromBillActId": 0, "DiscountActivityId": 0, "AccountPackageId": 0, "BillingIdentifierAccountProductId": 0, "TieredGroup": "string", "RateSource": "string", "AvalaraGroupKey": "string", "CostUnrounded": "string", "TaxCostUnrounded": "string", "PricingId": "string", "RateClassProductId": "string", "Estimated": 0, "SubscriptionToDate": "string", "RatingDate": "string", "EffectiveRated": 0 } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Updated": "string",
"UpdateError": "string",
"MDLEventId": 0,
"Created": "string",
"AccountId": 0,
"ProductId": 0,
"Id": "string",
"AccountProductId": 0,
"ActivityDate": "string",
"DiscountedBy": 0,
"RatedAmount": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"SubscriptionFromDate": "string",
"StandardCostUnrounded": "string",
"RateDate": "string",
"ReprocessQueueID": 0,
"Formula": "string",
"Quantity": "string",
"ProcessStatus": "string",
"ProcessDescription": "string",
"InvoiceId": 0,
"BillingIdentifierId": "string",
"ManualChargeByUserId": "string",
"CountryCodeMapId": "string",
"CollectorStageId": "string",
"ActivityCollectorId": "string",
"Feature": "string",
"EventInvoiceCycleId": "string",
"ContractId": "string",
"ContractRateId": "string",
"MinChargeFlag": "string",
"DestinationCountryCodeId": 0,
"OriginationCountryCodeId": 0,
"CurrencyCode": 0,
"PackageProductId": "string",
"ProrateFactor": "string",
"UpperBand": "string",
"AccumulatorValueId": 0,
"RatingMethodId": 0,
"ExchangeRateId": 0,
"PricingCurrencyCode": 0,
"SplitFromBillActId": 0,
"DiscountActivityId": 0,
"AccountPackageId": 0,
"BillingIdentifierAccountProductId": 0,
"TieredGroup": "string",
"RateSource": "string",
"AvalaraGroupKey": "string",
"CostUnrounded": "string",
"TaxCostUnrounded": "string",
"PricingId": "string",
"RateClassProductId": "string",
"Estimated": 0,
"SubscriptionToDate": "string",
"RatingDate": "string",
"EffectiveRated": 0
}
}'{ "retrieveResponse": { "Updated": "string", "UpdateError": "string", "MDLEventId": 0, "Created": "string", "AccountId": 0, "ProductId": 0, "Id": "string", "AccountProductId": 0, "ActivityDate": "string", "DiscountedBy": 0, "RatedAmount": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "SubscriptionFromDate": "string", "StandardCostUnrounded": "string", "RateDate": "string", "ReprocessQueueID": 0, "Formula": "string", "Quantity": "string", "ProcessStatus": "string", "ProcessDescription": "string", "InvoiceId": 0, "BillingIdentifierId": "string", "ManualChargeByUserId": "string", "CountryCodeMapId": "string", "CollectorStageId": "string", "ActivityCollectorId": "string", "Feature": "string", "EventInvoiceCycleId": "string", "ContractId": "string", "ContractRateId": "string", "MinChargeFlag": "string", "DestinationCountryCodeId": 0, "OriginationCountryCodeId": 0, "CurrencyCode": 0, "PackageProductId": "string", "ProrateFactor": "string", "UpperBand": "string", "AccumulatorValueId": 0, "RatingMethodId": 0, "ExchangeRateId": 0, "PricingCurrencyCode": 0, "SplitFromBillActId": 0, "DiscountActivityId": 0, "AccountPackageId": 0, "BillingIdentifierAccountProductId": 0, "TieredGroup": "string", "RateSource": "string", "AvalaraGroupKey": "string", "CostUnrounded": "string", "TaxCostUnrounded": "string", "PricingId": "string", "RateClassProductId": "string", "Estimated": 0, "SubscriptionToDate": "string", "RatingDate": "string", "EffectiveRated": 0 } }
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/delete/ACTIVITY \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'{ "retrieveResponse": { "Updated": "string", "UpdateError": "string", "MDLEventId": 0, "Created": "string", "AccountId": 0, "ProductId": 0, "Id": "string", "AccountProductId": 0, "ActivityDate": "string", "DiscountedBy": 0, "RatedAmount": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "SubscriptionFromDate": "string", "StandardCostUnrounded": "string", "RateDate": "string", "ReprocessQueueID": 0, "Formula": "string", "Quantity": "string", "ProcessStatus": "string", "ProcessDescription": "string", "InvoiceId": 0, "BillingIdentifierId": "string", "ManualChargeByUserId": "string", "CountryCodeMapId": "string", "CollectorStageId": "string", "ActivityCollectorId": "string", "Feature": "string", "EventInvoiceCycleId": "string", "ContractId": "string", "ContractRateId": "string", "MinChargeFlag": "string", "DestinationCountryCodeId": 0, "OriginationCountryCodeId": 0, "CurrencyCode": 0, "PackageProductId": "string", "ProrateFactor": "string", "UpperBand": "string", "AccumulatorValueId": 0, "RatingMethodId": 0, "ExchangeRateId": 0, "PricingCurrencyCode": 0, "SplitFromBillActId": 0, "DiscountActivityId": 0, "AccountPackageId": 0, "BillingIdentifierAccountProductId": 0, "TieredGroup": "string", "RateSource": "string", "AvalaraGroupKey": "string", "CostUnrounded": "string", "TaxCostUnrounded": "string", "PricingId": "string", "RateClassProductId": "string", "Estimated": 0, "SubscriptionToDate": "string", "RatingDate": "string", "EffectiveRated": 0 } }