Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" }, "externalIDFieldName": "TaxEngineInstanceName" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" }, "externalIDFieldName": "TaxEngineInstanceName" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/TAX_ENGINE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "TaxEngineInstanceName": "string", "SureTaxBatchSize": "string", "Status": "string", "UpdatedUserId": "string", "SureTaxValidationKey": "string", "SuretaxTranslationLogic": "string", "SureTaxCompressPayload": 0, "RetentionDays": "string", "GroupKey": "string", "IncludeActivityAdr": 0, "OauthAuthenticationKeyId": 0, "ConfigurationTrack": "string", "Id": "string", "TaxEngineTypeId": 0, "TaxEngineDescription": "string", "Login": "string", "Created": "string", "SureTaxClientNumber": "string", "SureTaxCalculationPrecision": "string", "IncludeShip": 0, "CreatedUserId": "string", "BillingComponentId": 0, "Updated": "string", "RollUp": 0, "ExclusionCriterion": 0, "EndpointUrl": "string", "CompanyCode": "string", "RequestTimeOut": "string", "TaxEngineExternalId": "string", "TranslationLogic": "string" } }