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_COLLECTOR/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "Type": "string", "FtpFilePattern": "string", "PrecollectorValidation": "string", "RejectClosedFlag": 0, "LookbackTimePeriodStart": "string", "FtpDirectory": "string", "FtpLocationType": "string", "Hostname": "string", "BillableActivityFlag": "string", "Username": "string", "LookbackTimePeriodEnd": "string", "RecordFormat": "string", "Status": "string", "ActivityCollectorName": "string", "CreateAfterProcessDirectoryFlag": 0, "HostPort": "string", "AfterProcessFilePattern": "string", "Delimiter": "string", "RateActivityFlag": "string", "SkipRows": "string", "FieldIncludedChar": "string", "TimeZoneId": 0, "AfterProcessDirectory": "string", "ConsolidationMode": "string", "FtpDataSource": 0, "AccountId": "string", "Created": "string", "Sproc": "string", "RunIntervalMin": "string", "LastRuntime": "string", "LastRowId": "string", "Entity_Id": "string", "EntityMethod": "string", "StartDate": "string", "Updated": "string", "ExternalEntityFieldId": "string", "RetrieveSql": "string", "LastRowIdChar": "string", "ServicePointTypeId": "string", "LoadOrder": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "OmitEnd": "string", "AfterProcessAction": "string" } }
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY_COLLECTOR?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'{ "retrieveResponse": { "Type": "string", "FtpFilePattern": "string", "PrecollectorValidation": "string", "RejectClosedFlag": 0, "LookbackTimePeriodStart": "string", "FtpDirectory": "string", "FtpLocationType": "string", "Hostname": "string", "BillableActivityFlag": "string", "Username": "string", "LookbackTimePeriodEnd": "string", "RecordFormat": "string", "Status": "string", "ActivityCollectorName": "string", "CreateAfterProcessDirectoryFlag": 0, "HostPort": "string", "AfterProcessFilePattern": "string", "Delimiter": "string", "RateActivityFlag": "string", "SkipRows": "string", "FieldIncludedChar": "string", "TimeZoneId": 0, "AfterProcessDirectory": "string", "ConsolidationMode": "string", "FtpDataSource": 0, "AccountId": "string", "Created": "string", "Sproc": "string", "RunIntervalMin": "string", "LastRuntime": "string", "LastRowId": "string", "Entity_Id": "string", "EntityMethod": "string", "StartDate": "string", "Updated": "string", "ExternalEntityFieldId": "string", "RetrieveSql": "string", "LastRowIdChar": "string", "ServicePointTypeId": "string", "LoadOrder": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "OmitEnd": "string", "AfterProcessAction": "string" } }
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Type": "string",
"FtpFilePattern": "string",
"PrecollectorValidation": "string",
"RejectClosedFlag": 0,
"LookbackTimePeriodStart": "string",
"FtpDirectory": "string",
"FtpLocationType": "string",
"Hostname": "string",
"BillableActivityFlag": "string",
"Username": "string",
"LookbackTimePeriodEnd": "string",
"RecordFormat": "string",
"Status": "string",
"ActivityCollectorName": "string",
"CreateAfterProcessDirectoryFlag": 0,
"HostPort": "string",
"AfterProcessFilePattern": "string",
"Delimiter": "string",
"RateActivityFlag": "string",
"SkipRows": "string",
"FieldIncludedChar": "string",
"TimeZoneId": 0,
"AfterProcessDirectory": "string",
"ConsolidationMode": "string",
"FtpDataSource": 0,
"AccountId": "string",
"Created": "string",
"Sproc": "string",
"RunIntervalMin": "string",
"LastRuntime": "string",
"LastRowId": "string",
"Entity_Id": "string",
"EntityMethod": "string",
"StartDate": "string",
"Updated": "string",
"ExternalEntityFieldId": "string",
"RetrieveSql": "string",
"LastRowIdChar": "string",
"ServicePointTypeId": "string",
"LoadOrder": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"Id": "string",
"OmitEnd": "string",
"AfterProcessAction": "string"
}
}'{ "retrieveResponse": { "Type": "string", "FtpFilePattern": "string", "PrecollectorValidation": "string", "RejectClosedFlag": 0, "LookbackTimePeriodStart": "string", "FtpDirectory": "string", "FtpLocationType": "string", "Hostname": "string", "BillableActivityFlag": "string", "Username": "string", "LookbackTimePeriodEnd": "string", "RecordFormat": "string", "Status": "string", "ActivityCollectorName": "string", "CreateAfterProcessDirectoryFlag": 0, "HostPort": "string", "AfterProcessFilePattern": "string", "Delimiter": "string", "RateActivityFlag": "string", "SkipRows": "string", "FieldIncludedChar": "string", "TimeZoneId": 0, "AfterProcessDirectory": "string", "ConsolidationMode": "string", "FtpDataSource": 0, "AccountId": "string", "Created": "string", "Sproc": "string", "RunIntervalMin": "string", "LastRuntime": "string", "LastRowId": "string", "Entity_Id": "string", "EntityMethod": "string", "StartDate": "string", "Updated": "string", "ExternalEntityFieldId": "string", "RetrieveSql": "string", "LastRowIdChar": "string", "ServicePointTypeId": "string", "LoadOrder": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "OmitEnd": "string", "AfterProcessAction": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Type": "string",
"FtpFilePattern": "string",
"PrecollectorValidation": "string",
"RejectClosedFlag": 0,
"LookbackTimePeriodStart": "string",
"FtpDirectory": "string",
"FtpLocationType": "string",
"Hostname": "string",
"BillableActivityFlag": "string",
"Username": "string",
"LookbackTimePeriodEnd": "string",
"RecordFormat": "string",
"Status": "string",
"ActivityCollectorName": "string",
"CreateAfterProcessDirectoryFlag": 0,
"HostPort": "string",
"AfterProcessFilePattern": "string",
"Delimiter": "string",
"RateActivityFlag": "string",
"SkipRows": "string",
"FieldIncludedChar": "string",
"TimeZoneId": 0,
"AfterProcessDirectory": "string",
"ConsolidationMode": "string",
"FtpDataSource": 0,
"AccountId": "string",
"Created": "string",
"Sproc": "string",
"RunIntervalMin": "string",
"LastRuntime": "string",
"LastRowId": "string",
"Entity_Id": "string",
"EntityMethod": "string",
"StartDate": "string",
"Updated": "string",
"ExternalEntityFieldId": "string",
"RetrieveSql": "string",
"LastRowIdChar": "string",
"ServicePointTypeId": "string",
"LoadOrder": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"Id": "string",
"OmitEnd": "string",
"AfterProcessAction": "string"
}
}'{ "retrieveResponse": { "Type": "string", "FtpFilePattern": "string", "PrecollectorValidation": "string", "RejectClosedFlag": 0, "LookbackTimePeriodStart": "string", "FtpDirectory": "string", "FtpLocationType": "string", "Hostname": "string", "BillableActivityFlag": "string", "Username": "string", "LookbackTimePeriodEnd": "string", "RecordFormat": "string", "Status": "string", "ActivityCollectorName": "string", "CreateAfterProcessDirectoryFlag": 0, "HostPort": "string", "AfterProcessFilePattern": "string", "Delimiter": "string", "RateActivityFlag": "string", "SkipRows": "string", "FieldIncludedChar": "string", "TimeZoneId": 0, "AfterProcessDirectory": "string", "ConsolidationMode": "string", "FtpDataSource": 0, "AccountId": "string", "Created": "string", "Sproc": "string", "RunIntervalMin": "string", "LastRuntime": "string", "LastRowId": "string", "Entity_Id": "string", "EntityMethod": "string", "StartDate": "string", "Updated": "string", "ExternalEntityFieldId": "string", "RetrieveSql": "string", "LastRowIdChar": "string", "ServicePointTypeId": "string", "LoadOrder": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "OmitEnd": "string", "AfterProcessAction": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Type": "string",
"FtpFilePattern": "string",
"PrecollectorValidation": "string",
"RejectClosedFlag": 0,
"LookbackTimePeriodStart": "string",
"FtpDirectory": "string",
"FtpLocationType": "string",
"Hostname": "string",
"BillableActivityFlag": "string",
"Username": "string",
"LookbackTimePeriodEnd": "string",
"RecordFormat": "string",
"Status": "string",
"ActivityCollectorName": "string",
"CreateAfterProcessDirectoryFlag": 0,
"HostPort": "string",
"AfterProcessFilePattern": "string",
"Delimiter": "string",
"RateActivityFlag": "string",
"SkipRows": "string",
"FieldIncludedChar": "string",
"TimeZoneId": 0,
"AfterProcessDirectory": "string",
"ConsolidationMode": "string",
"FtpDataSource": 0,
"AccountId": "string",
"Created": "string",
"Sproc": "string",
"RunIntervalMin": "string",
"LastRuntime": "string",
"LastRowId": "string",
"Entity_Id": "string",
"EntityMethod": "string",
"StartDate": "string",
"Updated": "string",
"ExternalEntityFieldId": "string",
"RetrieveSql": "string",
"LastRowIdChar": "string",
"ServicePointTypeId": "string",
"LoadOrder": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"Id": "string",
"OmitEnd": "string",
"AfterProcessAction": "string"
},
"externalIDFieldName": "ActivityCollectorName"
}'{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/delete/ACTIVITY_COLLECTOR \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'{ "retrieveResponse": { "Type": "string", "FtpFilePattern": "string", "PrecollectorValidation": "string", "RejectClosedFlag": 0, "LookbackTimePeriodStart": "string", "FtpDirectory": "string", "FtpLocationType": "string", "Hostname": "string", "BillableActivityFlag": "string", "Username": "string", "LookbackTimePeriodEnd": "string", "RecordFormat": "string", "Status": "string", "ActivityCollectorName": "string", "CreateAfterProcessDirectoryFlag": 0, "HostPort": "string", "AfterProcessFilePattern": "string", "Delimiter": "string", "RateActivityFlag": "string", "SkipRows": "string", "FieldIncludedChar": "string", "TimeZoneId": 0, "AfterProcessDirectory": "string", "ConsolidationMode": "string", "FtpDataSource": 0, "AccountId": "string", "Created": "string", "Sproc": "string", "RunIntervalMin": "string", "LastRuntime": "string", "LastRowId": "string", "Entity_Id": "string", "EntityMethod": "string", "StartDate": "string", "Updated": "string", "ExternalEntityFieldId": "string", "RetrieveSql": "string", "LastRowIdChar": "string", "ServicePointTypeId": "string", "LoadOrder": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "Id": "string", "OmitEnd": "string", "AfterProcessAction": "string" } }