API reference (1.0)

Billing Platform API

Download OpenAPI description

demogm_03_06_2025_schema_edited.json

demogm_03_06_2025_schema_edited.yaml

Overview

URL http://support.billingplatform.com

API Support support@billingplatform.com

License Apache 2.0

Servers

Mock server

https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/

https://my.billingplatform.com/demogm/

CONTRACT

CONTRACT API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

DESTINATION_COUNTRY_CODE

Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations

LANGUAGE

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE

Operations

PACKAGE

PACKAGE API Reference

Operations

PACKAGE_CURRENCY

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT

PACKAGE_PRODUCT API Reference

Operations

PARENT_PACKAGE_PRODUCT

Operations

PRICING

PRICING API Reference

Operations

PRODUCT

Configure the Products in your product catalog

Operations

RATE_CLASS

RATE_CLASS API Reference

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

RATING_METHOD API Reference

Operations

ACCOUNT

Account short help

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE

Identifies the billing and invoicing attributes for a given element of the hierarchy

Operations

CONTRACT

CONTRACT API Reference

Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

CURRENCY

CURRENCY API Reference

Operations

PRICING

PRICING API Reference

Operations

SHARING_GROUP

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER

SHARING_GROUP_USER API Reference

Operations

TIME_ZONE

TIME_ZONE API Reference

Operations

ACTIVITY

ACTIVITY API Reference

Operations

ACTIVITY_COLLECTOR

ACTIVITY_COLLECTOR API Reference

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS

COLLECTOR_FIELDS API Reference

Operations

CREDIT

CREDIT API Reference

Operations

CREDIT_ALLOCATION

CREDIT_ALLOCATION API Reference

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations

INVOICE

INVOICE API Reference

Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations

PAYMENT

PAYMENT API Reference

Operations

REFUND

REFUND API Reference

Operations

REFUND_TYPE

REFUND_TYPE API Reference

Operations

TAX_DETAIL

TAX_DETAIL API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT

ACCOUNT_CONTACT API Reference

Operations

CONTACT_TYPE

CONTACT_TYPE API Reference

Operations

CS_ACCOUNT_ACTION

CS_ACCOUNT_ACTION API Reference

Operations

CS_ACTION

CS_ACTION API Reference

Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY

CS_STRATEGY API Reference

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION

GENERAL_LEDGER_TRANSACTION API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT

REVREC_CONTRACT API Reference

Operations

ENTITY

ENTITY API Reference

Operations

ENTITY_FIELD

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ROLE

ENTITY_FIELD_ROLE API Reference

Operations

ENTITY_FIELD_VALUES

ENTITY_FIELD_VALUES API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT API Reference

Operations

QUOTE

QUOTE API Reference

Operations

QUOTE_PRODUCT

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

ACCOUNT

Account short help

Operations

ACCOUNTING_DASHBOARD

ACCOUNTING_DASHBOARD API Reference

Operations

ACCOUNTING_PERIOD

ACCOUNTING_PERIOD API Reference

Operations

ACCOUNTING_PERIOD_HISTORY

ACCOUNTING_PERIOD_HISTORY API Reference

Operations

ACCOUNTING_QUICK_LINK

ACCOUNTING_QUICK_LINK API Reference

Operations

ACCOUNT_CONTACT

ACCOUNT_CONTACT API Reference

Operations

ACCOUNT_ORDER

ACCOUNT_ORDER API Reference

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PACKAGE_PRODUCT

ACCOUNT_PACKAGE_PRODUCT API Reference

Operations

ACCOUNT_PRICING_CURRENCY

ACCOUNT_PRICING_CURRENCY API Reference

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

ACCOUNT_PRODUCT_RELATION

ACCOUNT_PRODUCT_RELATION API Reference

Operations

ACCOUNT_PRODUCT_VERSION

ACCOUNT_PRODUCT_VERSION API Reference

Operations

ACCOUNT_PRODUCT_VERSION_ITEM

ACCOUNT_PRODUCT_VERSION_ITEM API Reference

Operations

ACCOUNT_PRODUCT_VERSION_REPORT

ACCOUNT_PRODUCT_VERSION_REPORT API Reference

Operations

ACCOUNT_TAX_EXEMPTION

ACCOUNT_TAX_EXEMPTION API Reference

Operations

ACCOUNT_TRANSACTION_LEDGER

ACCOUNT_TRANSACTION_LEDGER API Reference

Operations

ACCOUNT_TYPE

ACCOUNT_TYPE API Reference

Operations

ACCUMULATOR_VALUE_DETAILS

ACCUMULATOR_VALUE_DETAILS API Reference

Operations

ACCUMULATOR_VALUE_INVOICE

ACCUMULATOR_VALUE_INVOICE API Reference

Operations

ACTIVITY

ACTIVITY API Reference

Operations

ACTIVITY_COLLECTOR

ACTIVITY_COLLECTOR API Reference

Operations

ACTIVITY_COLLECTOR_HISTORY

ACTIVITY_COLLECTOR_HISTORY API Reference

Operations

ADHOC_SCHEDULED_REPORT

ADHOC_SCHEDULED_REPORT API Reference

Operations

ADJUSTMENT

ADJUSTMENT API Reference

Operations

ALERT

ALERT API Reference

Operations

ALERT_BATCH_QUEUE

ALERT_BATCH_QUEUE API Reference

Operations

ALERT_GROUP

ALERT_GROUP API Reference

Operations

ALERT_TYPE

ALERT_TYPE API Reference

Operations

APPLICATION_USER

APPLICATION_USER API Reference

Operations

APPROVAL_HISTORY

APPROVAL_HISTORY API Reference

Operations

APPROVAL_HISTORY_DETAIL

APPROVAL_HISTORY_DETAIL API Reference

Operations

APPROVAL_REQUEST

APPROVAL_REQUEST API Reference

Operations

APPROVAL_REQUEST_DETAIL

APPROVAL_REQUEST_DETAIL API Reference

Operations

AVALARA_REQUEST

AVALARA_REQUEST API Reference

Operations

BILLING_ACTIVITY_DISCOUNT

BILLING_ACTIVITY_DISCOUNT API Reference

Operations

BILLING_ACTIVITY_FORMULA

BILLING_ACTIVITY_FORMULA API Reference

Operations

BILLING_ACTIVITY_TAX

BILLING_ACTIVITY_TAX API Reference

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

BILLING_PROFILE

Identifies the billing and invoicing attributes for a given element of the hierarchy

Operations

BILLING_PROFILE_LEDGER

BILLING_PROFILE_LEDGER API Reference

Operations

BILLSOFT_TAX_TYPE

BILLSOFT_TAX_TYPE API Reference

Operations

BPPAY_REPORT

BPPAY_REPORT API Reference

Operations

BP_METRICS

BP_METRICS API Reference

Operations

BP_METRICS_LOG

BP_METRICS_LOG API Reference

Operations

BULK_API_REQUEST

BULK_API_REQUEST API Reference

Operations

BULK_APPROVE_REJECT_CREDITS

BULK_APPROVE_REJECT_CREDITS API Reference

Operations

BULK_DATA_LOADER

BULK_DATA_LOADER API Reference

Operations

BULK_RERATE_INVOICES

BULK_RERATE_INVOICES API Reference

Operations

BULK_RESPONSE

BULK_RESPONSE API Reference

Operations

BULK_UPLOAD_HISTORY

BULK_UPLOAD_HISTORY API Reference

Operations

BUNDLE

BUNDLE API Reference

Operations

BUNDLE_CONFIGURATION

BUNDLE_CONFIGURATION API Reference

Operations

BUNDLE_CONTENT

BUNDLE_CONTENT API Reference

Operations

BUNDLE_LOG

BUNDLE_LOG API Reference

Operations

CHARGE_ESTIMATION_RUN_HISTORY

CHARGE_ESTIMATION_RUN_HISTORY API Reference

Operations

COLLECTOR_AGGREGATE_FIELD

COLLECTOR_AGGREGATE_FIELD API Reference

Operations

COLLECTOR_CRITERIA_FIELD

COLLECTOR_CRITERIA_FIELD API Reference

Operations

COLLECTOR_EXT_ENTITY_FIELD

COLLECTOR_EXT_ENTITY_FIELD API Reference

Operations

COLLECTOR_FIELDS

COLLECTOR_FIELDS API Reference

Operations

COLLECTOR_FIELD_MAPPING

COLLECTOR_FIELD_MAPPING API Reference

Operations

COLLECTOR_LOAD_STATUS

COLLECTOR_LOAD_STATUS API Reference

Operations

COLLECTOR_RERATE_FIELD

COLLECTOR_RERATE_FIELD API Reference

Operations

COLLECTOR_ROLLBACK_QUEUE

COLLECTOR_ROLLBACK_QUEUE API Reference

Operations

COLLECTOR_UPLOAD_PROGRESS

COLLECTOR_UPLOAD_PROGRESS API Reference

Operations

COMMITMENT_INCLUSION_CRITERIA

COMMITMENT_INCLUSION_CRITERIA API Reference

Operations

COMMITMENT_SCOPE

COMMITMENT_SCOPE API Reference

Operations

COMPANY_PROFILE

COMPANY_PROFILE API Reference

Operations

CONDITION

CONDITION API Reference

Operations

CONDITION_GROUP_MEMBER

CONDITION_GROUP_MEMBER API Reference

Operations

CONTACT_TYPE

CONTACT_TYPE API Reference

Operations

CONTRACT

CONTRACT API Reference

Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

CREDIT

CREDIT API Reference

Operations

CREDIT_ALLOCATION

CREDIT_ALLOCATION API Reference

Operations

CREDIT_LINE_ITEM

CREDIT_LINE_ITEM API Reference

Operations

CREDIT_TAX_DETAIL

CREDIT_TAX_DETAIL API Reference

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

CS_ACCOUNT

CS_ACCOUNT API Reference

Operations

CS_ACCOUNT_ACTION

CS_ACCOUNT_ACTION API Reference

Operations

CS_ACCOUNT_BALANCES

CS_ACCOUNT_BALANCES API Reference

Operations

CS_ACTION

CS_ACTION API Reference

Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_EMAIL_ATTACHMENT

CS_EMAIL_ATTACHMENT API Reference

Operations

CS_MODULE_CONFIGURATION

CS_MODULE_CONFIGURATION API Reference

Operations

CS_PTP

CS_PTP API Reference

Operations

CS_PTP_INVOICE

CS_PTP_INVOICE API Reference

Operations

CS_PTP_PAYMENT

CS_PTP_PAYMENT API Reference

Operations

CS_STRATEGY

CS_STRATEGY API Reference

Operations

CS_SUMMARY

CS_SUMMARY API Reference

Operations

CURRENCY

CURRENCY API Reference

Operations

CUSTOMER_AUTO_PAYMENT

CUSTOMER_AUTO_PAYMENT API Reference

Operations

CUSTOMER_BILLING_PROFILE

CUSTOMER_BILLING_PROFILE API Reference

Operations

CUSTOM_FIELD_LABEL_VERSION

CUSTOM_FIELD_LABEL_VERSION API Reference

Operations

CUSTOM_FUNCTION

CUSTOM_FUNCTION API Reference

Operations

CUSTOM_REPORT

CUSTOM_REPORT API Reference

Operations

CUSTOM_REPORT_FIELD

CUSTOM_REPORT_FIELD API Reference

Operations

CUSTOM_REPORT_FILTER

CUSTOM_REPORT_FILTER API Reference

Operations

CUSTOM_REPORT_LABEL_VERSION

CUSTOM_REPORT_LABEL_VERSION API Reference

Operations

DATA_SOURCE

DATA_SOURCE API Reference

Operations

DISCOUNT_ELIG_FILTER

DISCOUNT_ELIG_FILTER API Reference

Operations

DISCOUNT_TARGET_FILTER

DISCOUNT_TARGET_FILTER API Reference

Operations

DOCGEN_QUEUE

DOCGEN_QUEUE API Reference

Operations

DOCUMENT_STORAGE

DOCUMENT_STORAGE API Reference

Operations

DOCUMENT_TEMPLATE

DOCUMENT_TEMPLATE API Reference

Operations

DOCUMENT_TEMPLATE_QUERY

DOCUMENT_TEMPLATE_QUERY API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations

DUNNING_INTERVAL_EMAIL

DUNNING_INTERVAL_EMAIL API Reference

Operations

ECOM_TRANSACTION

ECOM_TRANSACTION API Reference

Operations

ECOM_TRANSACTION_REQUEST_FIELD

ECOM_TRANSACTION_REQUEST_FIELD API Reference

Operations

ECOM_TRANSACTION_RESPONSE

ECOM_TRANSACTION_RESPONSE API Reference

Operations

ECOM_TRANSACTION_RESP_FIELD

ECOM_TRANSACTION_RESP_FIELD API Reference

Operations

EFILE

EFILE API Reference

Operations

EFILE_EVENT

EFILE_EVENT API Reference

Operations

EFILE_EVENT_CONTENT

EFILE_EVENT_CONTENT API Reference

Operations

EFILE_FORMAT_FIELDS

EFILE_FORMAT_FIELDS API Reference

Operations

EFILE_TEMPLATE

EFILE_TEMPLATE API Reference

Operations

EINVOICE_COUNTRY

EINVOICE_COUNTRY API Reference

Operations

EINVOICE_DOCUMENT_TYPE

EINVOICE_DOCUMENT_TYPE API Reference

Operations

EINVOICE_FORMAT

EINVOICE_FORMAT API Reference

Operations

EINVOICE_NETWORK

EINVOICE_NETWORK API Reference

Operations

EINVOICE_PROFILE

EINVOICE_PROFILE API Reference

Operations

EINVOICE_XML_ENGINE

EINVOICE_XML_ENGINE API Reference

Operations

EMAIL_TEMPLATE

EMAIL_TEMPLATE API Reference

Operations

EMAIL_TEMPLATE_TYPE

EMAIL_TEMPLATE_TYPE API Reference

Operations

ENTITY

ENTITY API Reference

Operations

ENTITY_DOMAIN_ROLE

ENTITY_DOMAIN_ROLE API Reference

Operations

ENTITY_FIELD

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ADDITION_ATTR

ENTITY_FIELD_ADDITION_ATTR API Reference

Operations

ENTITY_FIELD_CASCADE

ENTITY_FIELD_CASCADE API Reference

Operations

ENTITY_FIELD_INPUT_ROLE

ENTITY_FIELD_INPUT_ROLE API Reference

Operations

ENTITY_FIELD_PICK_LIST

ENTITY_FIELD_PICK_LIST API Reference

Operations

ENTITY_FIELD_ROLE

ENTITY_FIELD_ROLE API Reference

Operations

ENTITY_FIELD_VALUES

ENTITY_FIELD_VALUES API Reference

Operations

ENTITY_LAYOUT

ENTITY_LAYOUT API Reference

Operations

ENTITY_LAYOUT_CONFIGURATION

ENTITY_LAYOUT_CONFIGURATION API Reference

Operations

ENTITY_LAYOUT_CONFIGURATION_FIELD

ENTITY_LAYOUT_CONFIGURATION_FIELD API Reference

Operations

ENTITY_LAYOUT_CONFIGURATION_GROUP

ENTITY_LAYOUT_CONFIGURATION_GROUP API Reference

Operations

ENTITY_LAYOUT_FIELD

ENTITY_LAYOUT_FIELD API Reference

Operations

ENTITY_LAYOUT_FILTER

ENTITY_LAYOUT_FILTER API Reference

Operations

ENTITY_VALIDATION

ENTITY_VALIDATION API Reference

Operations

ENTITY_VIEW_FILTER_MET

ENTITY_VIEW_FILTER_MET API Reference

Operations

ENTITY_WIDGET

ENTITY_WIDGET API Reference

Operations

ENTITY_WIDGET_ROLE

ENTITY_WIDGET_ROLE API Reference

Operations

ENTITY_WIDGET_RULE_MET

ENTITY_WIDGET_RULE_MET API Reference

Operations

EVENT_GROUP

EVENT_GROUP API Reference

Operations

EVENT_INVOICE_CYCLE

EVENT_INVOICE_CYCLE API Reference

Operations

EXCHANGE_RATE

EXCHANGE_RATE API Reference

Operations

EXTENSION_WIDGET

EXTENSION_WIDGET API Reference

Operations

EXTENSION_WIDGET_ROLE

EXTENSION_WIDGET_ROLE API Reference

Operations

EXTERNAL_USER

EXTERNAL_USER API Reference

Operations

EXTERNAL_USER_ACCOUNT

EXTERNAL_USER_ACCOUNT API Reference

Operations

FINANCIAL_ACCOUNT

FINANCIAL_ACCOUNT API Reference

Operations

FINANCIAL_ACCOUNT_CATEGORY

FINANCIAL_ACCOUNT_CATEGORY API Reference

Operations

FINANCIAL_CRITERIA

FINANCIAL_CRITERIA API Reference

Operations

FINANCIAL_CRITERIA_ATTR

FINANCIAL_CRITERIA_ATTR API Reference

Operations

FINANCIAL_CRITERIA_RULE

FINANCIAL_CRITERIA_RULE API Reference

Operations

FINANCIAL_PERIOD

FINANCIAL_PERIOD API Reference

Operations

FINANCIAL_PERIOD_CONFIGURATION

FINANCIAL_PERIOD_CONFIGURATION API Reference

Operations

FINANCIAL_PERIOD_INVOICE

FINANCIAL_PERIOD_INVOICE API Reference

Operations

FINANCIAL_QUEUE

FINANCIAL_QUEUE API Reference

Operations

FINANCIAL_QUEUE_ALERT

FINANCIAL_QUEUE_ALERT API Reference

Operations

FORMULA_GROUP_IDENTIFIER

FORMULA_GROUP_IDENTIFIER API Reference

Operations

FORMULA_INVOICING_FILTER

FORMULA_INVOICING_FILTER API Reference

Operations

FTP_DATA_SOURCE

FTP_DATA_SOURCE API Reference

Operations

FTP_QUEUE_EVENT

FTP_QUEUE_EVENT API Reference

Operations

GENERAL_LEDGER_TRANSACTION

GENERAL_LEDGER_TRANSACTION API Reference

Operations

GENERAL_LEDGER_VOIDED_INVOICE

GENERAL_LEDGER_VOIDED_INVOICE API Reference

Operations

HISTORY_QUEUE

HISTORY_QUEUE API Reference

Operations

HISTORY_SALESFORCE_SYNC

HISTORY_SALESFORCE_SYNC API Reference

Operations

HTTP_EVENT

HTTP_EVENT API Reference

Operations

INVOICE

INVOICE API Reference

Operations

INVOICE_BATCH_HISTORY

INVOICE_BATCH_HISTORY API Reference

Operations

INVOICE_CLOSE_SET

INVOICE_CLOSE_SET API Reference

Operations

INVOICE_CYCLE_CONFIG

INVOICE_CYCLE_CONFIG API Reference

Operations

INVOICE_DELIVERY_HISTORY

INVOICE_DELIVERY_HISTORY API Reference

Operations

INVOICE_DETAIL

INVOICE_DETAIL API Reference

Operations

INVOICE_ESTIMATE_CONFIG

Mid-Invoice Cycle Charge Estimation

Operations

INVOICE_GROUP

INVOICE_GROUP API Reference

Operations

INVOICE_GROUP_CONDITION

INVOICE_GROUP_CONDITION API Reference

Operations

INVOICE_GROUP_DETAIL

INVOICE_GROUP_DETAIL API Reference

Operations

INVOICE_MANAGEMENT

INVOICE_MANAGEMENT API Reference

Operations

INVOICE_MERGE

INVOICE_MERGE API Reference

Operations

INVOICE_MERGE_ACTIVITY

INVOICE_MERGE_ACTIVITY API Reference

Operations

INVOICE_MERGE_DETAIL

INVOICE_MERGE_DETAIL API Reference

Operations

INVOICE_PAYMENT_ADDRESS

INVOICE_PAYMENT_ADDRESS API Reference

Operations

INVOICE_PDF

INVOICE_PDF API Reference

Operations

INVOICE_PENDING_CHARGE

INVOICE_PENDING_CHARGE API Reference

Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations

INVOICE_TEMPLATE_FIELDS

INVOICE_TEMPLATE_FIELDS API Reference

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

INVOICE_XSL

INVOICE_XSL API Reference

Operations

INVOICING_SUMMARY

INVOICING_SUMMARY API Reference

Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations

LANGUAGE

LANGUAGE API Reference

Operations

LANGUAGE_BROWSER

LANGUAGE_BROWSER API Reference

Operations

LEDGER

LEDGER API Reference

Operations

LINKED_OVERAGE_COMPONENT

LINKED_OVERAGE_COMPONENT API Reference

Operations

LOCKBOX_CONFIGURATION

LOCKBOX_CONFIGURATION API Reference

Operations

LOCKBOX_INVOICE_ALLOCATION

LOCKBOX_INVOICE_ALLOCATION API Reference

Operations

LOCKBOX_MATCHING_RULE

LOCKBOX_MATCHING_RULE API Reference

Operations

LOCKBOX_MATCHING_RULE_MET

LOCKBOX_MATCHING_RULE_MET API Reference

Operations

LOCKBOX_RECORD

LOCKBOX_RECORD API Reference

Operations

LOCKBOX_UPLOAD_HISTORY

LOCKBOX_UPLOAD_HISTORY API Reference

Operations

MDL_EVENT

MDL_EVENT API Reference

Operations

MDL_RECONCILIATION_RUN

MDL_RECONCILIATION_RUN API Reference

Operations

MDL_RECONCILIATION_RUN_RESULTS

MDL_RECONCILIATION_RUN_RESULTS API Reference

Operations

MDL_ROLLBACK_FAILURE

MDL_ROLLBACK_FAILURE API Reference

Operations

MFA_INFORMATION

MFA_INFORMATION API Reference

Operations

MICROSOFT_DYNAMICS_CONNECTOR

MICROSOFT_DYNAMICS_CONNECTOR API Reference

Operations

MICROSOFT_DYNAMICS_JOB_FIELD

MICROSOFT_DYNAMICS_JOB_FIELD API Reference

Operations

MICROSOFT_DYNAMICS_JOB_FILTER

MICROSOFT_DYNAMICS_JOB_FILTER API Reference

Operations

MICROSOFT_DYNAMICS_JOB_RUN_HISTORY

MICROSOFT_DYNAMICS_JOB_RUN_HISTORY API Reference

Operations

MICROSOFT_DYNAMICS_MAPPING

MICROSOFT_DYNAMICS_MAPPING API Reference

Operations

MICROSOFT_DYNAMICS_SYNC_JOB

MICROSOFT_DYNAMICS_SYNC_JOB API Reference

Operations

MICROSOFT_DYNAMICS_UPSERT_FIELD

MICROSOFT_DYNAMICS_UPSERT_FIELD API Reference

Operations

MIN_MAX_CHARGE

MIN_MAX_CHARGE API Reference

Operations

NATURAL_LANGUAGE_REPORT

NATURAL_LANGUAGE_REPORT API Reference

Operations

ORDERS

ORDERS API Reference

Operations

ORDER_HISTORY

ORDER_HISTORY API Reference

Operations

ORDER_LINE_ITEM

ORDER_LINE_ITEM API Reference

Operations

ORDER_STATUS

ORDER_STATUS API Reference

Operations

ORG_COMPARISON_BUNDLE

ORG_COMPARISON_BUNDLE API Reference

Operations

ORG_COMPARISON_INSTANCE

ORG_COMPARISON_INSTANCE API Reference

Operations

ORG_COMPARISON_ITEM

ORG_COMPARISON_ITEM API Reference

Operations

ORG_COMPARISON_ITEM_FILE

ORG_COMPARISON_ITEM_FILE API Reference

Operations

ORG_COMPARISON_ITEM_RESULT

ORG_COMPARISON_ITEM_RESULT API Reference

Operations

PACKAGE

PACKAGE API Reference

Operations

PACKAGE_COMPONENT_HIER

PACKAGE_COMPONENT_HIER API Reference

Operations

PACKAGE_CURRENCY

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PACKAGE_relation

PACKAGE_PACKAGE_relation API Reference

Operations

PACKAGE_PRODUCT

PACKAGE_PRODUCT API Reference

Operations

PACKAGE_PRODUCT_USAGE_IDENTIFIER_relation

PACKAGE_PRODUCT_USAGE_IDENTIFIER_relation API Reference

Operations

PAGE_WIDGET

PAGE_WIDGET API Reference

Operations

PAGE_WIDGET_ROLE

PAGE_WIDGET_ROLE API Reference

Operations

PARENT_ACCOUNT

PARENT_ACCOUNT API Reference

Operations

PAYMENT

PAYMENT API Reference

Operations

PAYMENTS_GATEWAY_LOGS

PAYMENTS_GATEWAY_LOGS API Reference

Operations

PAYMENTS_REFUNDS

PAYMENTS_REFUNDS API Reference

Operations

PAYMENT_ALLOCATION

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_ALLOCATION_MAPPING

PAYMENT_ALLOCATION_MAPPING API Reference

Operations

PAYMENT_CHARGEBACK

PAYMENT_CHARGEBACK API Reference

Operations

PAYMENT_CHARGEBACK_FILE

PAYMENT_CHARGEBACK_FILE API Reference

Operations

PAYMENT_GATEWAY

PAYMENT_GATEWAY API Reference

Operations

PAYMENT_GATEWAY_DATA

PAYMENT_GATEWAY_DATA API Reference

Operations

PAYMENT_GATEWAY_FIELD

PAYMENT_GATEWAY_FIELD API Reference

Operations

PAYMENT_GATEWAY_PROFILE

PAYMENT_GATEWAY_PROFILE API Reference

Operations

PAYMENT_GATEWAY_PROFILE_FIELD

PAYMENT_GATEWAY_PROFILE_FIELD API Reference

Operations

PAYMENT_GATEWAY_PROFILE_RULE

PAYMENT_GATEWAY_PROFILE_RULE API Reference

Operations

PAYMENT_REPROCESS

PAYMENT_REPROCESS API Reference

Operations

PAYMENT_RETRY_SCHEDULE

PAYMENT_RETRY_SCHEDULE API Reference

Operations

PAYMENT_TRANSACTION_FEE

PAYMENT_TRANSACTION_FEE API Reference

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

PAYOUT

PAYOUT API Reference

Operations

PAYOUT_DETAIL

PAYOUT_DETAIL API Reference

Operations

PERIOD_CLOSE_TASK

PERIOD_CLOSE_TASK API Reference

Operations

PERIOD_CLOSE_TASK_FILTER

PERIOD_CLOSE_TASK_FILTER API Reference

Operations

PERIOD_CLOSE_TASK_STATUS

PERIOD_CLOSE_TASK_STATUS API Reference

Operations

PRICING

PRICING API Reference

Operations

PRICING_ATTRIBUTE

PRICING_ATTRIBUTE API Reference

Operations

PRICING_DRAFT

PRICING_DRAFT API Reference

Operations

PRICING_DRAFT_CALC_DETAIL

PRICING_DRAFT_CALC_DETAIL API Reference

Operations

PRICING_DRAFT_RULE_EXCLUDE

PRICING_DRAFT_RULE_EXCLUDE API Reference

Operations

PRICING_FORMULA

PRICING_FORMULA API Reference

Operations

PRICING_PLAN

PRICING_PLAN API Reference

Operations

PROCESS_CONSOLE

PROCESS_CONSOLE API Reference

Operations

PROCESS_METRIC_HISTORY

PROCESS_METRIC_HISTORY API Reference

Operations

PROCESS_METRIC_LOG

PROCESS_METRIC_LOG API Reference

Operations

PROCESS_METRIC_POINT

PROCESS_METRIC_POINT API Reference

Operations

PROCESS_QUEUE_ACCOUNT_PRODUCT_VERSION

PROCESS_QUEUE_ACCOUNT_PRODUCT_VERSION API Reference

Operations

PROCESS_QUEUE_ADHOC_REPORT

PROCESS_QUEUE_ADHOC_REPORT API Reference

Operations

PROCESS_QUEUE_ALERT

PROCESS_QUEUE_ALERT API Reference

Operations

PROCESS_QUEUE_BULK_REQUEST

PROCESS_QUEUE_BULK_REQUEST API Reference

Operations

PROCESS_QUEUE_BULK_UPLOAD

PROCESS_QUEUE_BULK_UPLOAD API Reference

Operations

PROCESS_QUEUE_COLLECTOR_LOAD

PROCESS_QUEUE_COLLECTOR_LOAD API Reference

Operations

PROCESS_QUEUE_CREDIT_CARD_REQUEST

PROCESS_QUEUE_CREDIT_CARD_REQUEST API Reference

Operations

PROCESS_QUEUE_CS_ACCOUNT

PROCESS_QUEUE_CS_ACCOUNT API Reference

Operations

PROCESS_QUEUE_CS_ACCOUNT_ACTION

PROCESS_QUEUE_CS_ACCOUNT_ACTION API Reference

Operations

PROCESS_QUEUE_DUNNING

PROCESS_QUEUE_DUNNING API Reference

Operations

PROCESS_QUEUE_EFILE

PROCESS_QUEUE_EFILE API Reference

Operations

PROCESS_QUEUE_EINVOICE

PROCESS_QUEUE_EINVOICE API Reference

Operations

PROCESS_QUEUE_EMAIL

PROCESS_QUEUE_EMAIL API Reference

Operations

PROCESS_QUEUE_EMPTY_RECYCLE_BIN

PROCESS_QUEUE_EMPTY_RECYCLE_BIN API Reference

Operations

PROCESS_QUEUE_FINANCIAL

PROCESS_QUEUE_FINANCIAL API Reference

Operations

PROCESS_QUEUE_FORMULA_CALC

PROCESS_QUEUE_FORMULA_CALC API Reference

Operations

PROCESS_QUEUE_FTP

PROCESS_QUEUE_FTP API Reference

Operations

PROCESS_QUEUE_FTP_DATA

PROCESS_QUEUE_FTP_DATA API Reference

Operations

PROCESS_QUEUE_INVOICE_CLOSE

PROCESS_QUEUE_INVOICE_CLOSE API Reference

Operations

PROCESS_QUEUE_INVOICE_ESTIMATE

PROCESS_QUEUE_INVOICE_ESTIMATE API Reference

Operations

PROCESS_QUEUE_INVOICE_FINISH_CLOSE

PROCESS_QUEUE_INVOICE_FINISH_CLOSE API Reference

Operations

PROCESS_QUEUE_INVOICE_GEN

PROCESS_QUEUE_INVOICE_GEN API Reference

Operations

PROCESS_QUEUE_INVOICE_PDF

PROCESS_QUEUE_INVOICE_PDF API Reference

Operations

PROCESS_QUEUE_INVOICE_POST_RATING

PROCESS_QUEUE_INVOICE_POST_RATING API Reference

Operations

PROCESS_QUEUE_INVOICE_REOPEN

PROCESS_QUEUE_INVOICE_REOPEN API Reference

Operations

PROCESS_QUEUE_LATE_FEE

PROCESS_QUEUE_LATE_FEE API Reference

Operations

PROCESS_QUEUE_LOCKBOX_UPLOAD

PROCESS_QUEUE_LOCKBOX_UPLOAD API Reference

Operations

PROCESS_QUEUE_MAPPING

PROCESS_QUEUE_MAPPING API Reference

Operations

PROCESS_QUEUE_ONE_TIME_CHARGE

PROCESS_QUEUE_ONE_TIME_CHARGE API Reference

Operations

PROCESS_QUEUE_ORG_COMPARISON_INSTANCE

PROCESS_QUEUE_ORG_COMPARISON_INSTANCE API Reference

Operations

PROCESS_QUEUE_POST_RATING

PROCESS_QUEUE_POST_RATING API Reference

Operations

PROCESS_QUEUE_RATE_LOAD

PROCESS_QUEUE_RATE_LOAD API Reference

Operations

PROCESS_QUEUE_RATING

PROCESS_QUEUE_RATING API Reference

Operations

PROCESS_QUEUE_RECYCLE_BIN

PROCESS_QUEUE_RECYCLE_BIN API Reference

Operations

PROCESS_QUEUE_REPORT_RUNTIME_CHECK

PROCESS_QUEUE_REPORT_RUNTIME_CHECK API Reference

Operations

PROCESS_QUEUE_REPROCESS

PROCESS_QUEUE_REPROCESS API Reference

Operations

PROCESS_QUEUE_RETRY_PAYMENT

PROCESS_QUEUE_RETRY_PAYMENT API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

PROCESS_QUEUE_ROLLBACK

PROCESS_QUEUE_ROLLBACK API Reference

Operations

PROCESS_QUEUE_SCHEDULER_REPORT

PROCESS_QUEUE_SCHEDULER_REPORT API Reference

Operations

PROCESS_QUEUE_STATEMENT_GENERATION

PROCESS_QUEUE_STATEMENT_GENERATION API Reference

Operations

PROCESS_QUEUE_SUBSCRIPTION

PROCESS_QUEUE_SUBSCRIPTION API Reference

Operations

PROCESS_QUEUE_SUBSCRIPTION_PAUSE

PROCESS_QUEUE_SUBSCRIPTION_PAUSE API Reference

Operations

PROCESS_QUEUE_TAX

PROCESS_QUEUE_TAX API Reference

Operations

PROCESS_QUEUE_UDP

PROCESS_QUEUE_UDP API Reference

Operations

PROCESS_QUEUE_WORKFLOW

PROCESS_QUEUE_WORKFLOW API Reference

Operations

PROCESS_SERVICE_MAINTENANCE

PROCESS_SERVICE_MAINTENANCE API Reference

Operations

PRODUCT

Configure the Products in your product catalog

Operations

PRODUCT_ACCUMULATOR_VALUE

PRODUCT_ACCUMULATOR_VALUE API Reference

Operations

PRODUCT_RELATIONSHIPS

PRODUCT_RELATIONSHIPS API Reference

Operations

PRODUCT_USAGE_IDENTIFIER

PRODUCT_USAGE_IDENTIFIER API Reference

Operations

QUANTITY_HISTORY

QUANTITY_HISTORY API Reference

Operations

QUERY_API_REQUEST

QUERY_API_REQUEST API Reference

Operations

QUEUE

QUEUE API Reference

Operations

QUEUE_EVENT

QUEUE_EVENT API Reference

Operations

QUOTE

QUOTE API Reference

Operations

QUOTE_AVAILABLE_PRODUCT

QUOTE_AVAILABLE_PRODUCT API Reference

Operations

QUOTE_DELIVERY_HISTORY

QUOTE_DELIVERY_HISTORY API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT API Reference

Operations

QUOTE_OVERAGE_PRODUCT

QUOTE_OVERAGE_PRODUCT API Reference

Operations

QUOTE_OVERAGE_PRODUCT_PERIOD

QUOTE_OVERAGE_PRODUCT_PERIOD API Reference

Operations

QUOTE_PERIOD

QUOTE_PERIOD API Reference

Operations

QUOTE_PERIOD_DRAFT

QUOTE_PERIOD_DRAFT API Reference

Operations

QUOTE_PERIOD_TEMPLATE

QUOTE_PERIOD_TEMPLATE API Reference

Operations

QUOTE_PRODUCT

QUOTE_PRODUCT API Reference

Operations

QUOTE_PRODUCT_DRAFT

QUOTE_PRODUCT_DRAFT API Reference

Operations

QUOTE_PRODUCT_PERIOD

QUOTE_PRODUCT_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD_DRAFT

QUOTE_PRODUCT_PERIOD_DRAFT API Reference

Operations

QUOTE_PRODUCT_SECTION

QUOTE_PRODUCT_SECTION API Reference

Operations

QUOTE_RELATIONSHIP_GROUP

QUOTE_RELATIONSHIP_GROUP API Reference

Operations

QUOTE_RULE

QUOTE_RULE API Reference

Operations

QUOTE_RULES

QUOTE_RULES API Reference

Operations

QUOTE_RULE_AGGREGATE_CONDITION

QUOTE_RULE_AGGREGATE_CONDITION API Reference

Operations

QUOTE_RULE_CONDITION

QUOTE_RULE_CONDITION API Reference

Operations

RATE_CLASS

RATE_CLASS API Reference

Operations

RATE_CLASS_CURRENCY

RATE_CLASS_CURRENCY API Reference

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

RATING_METHOD API Reference

Operations

RATING_METHOD_FIELD_OVERRIDE

RATING_METHOD_FIELD_OVERRIDE API Reference

Operations

RATING_METHOD_TYPE

RATING_METHOD_TYPE API Reference

Operations

RATING_QUEUE

RATING_QUEUE API Reference

Operations

RECYCLE_BIN

RECYCLE_BIN API Reference

Operations

REFUND

REFUND API Reference

Operations

REFUND_TYPE

REFUND_TYPE API Reference

Operations

REGIONAL_SETTINGS

REGIONAL_SETTINGS API Reference

Operations

REPROCESS_QUEUE

REPROCESS_QUEUE API Reference

Operations

REVREC_CONTRACT

REVREC_CONTRACT API Reference

Operations

REVREC_CONTRACT_EVENT

REVREC_CONTRACT_EVENT API Reference

Operations

REVREC_CONTRACT_PREVIEW

REVREC_CONTRACT_PREVIEW API Reference

Operations

REVREC_CONTRACT_PRODUCT

REVREC_CONTRACT_PRODUCT API Reference

Operations

REVREC_CONTRACT_PRODUCT_EVENT

REVREC_CONTRACT_PRODUCT_EVENT API Reference

Operations

REVREC_CONTRACT_PRODUCT_PREVIEW

REVREC_CONTRACT_PRODUCT_PREVIEW API Reference

Operations

REVREC_MODULE_CONFIGURATION

REVREC_MODULE_CONFIGURATION API Reference

Operations

REVREC_PERFORMANCE_OBLIGATION

REVREC_PERFORMANCE_OBLIGATION API Reference

Operations

REVREC_UPDATE_RULE

REVREC_UPDATE_RULE API Reference

Operations

REVREC_UPDATE_RULE_MET

REVREC_UPDATE_RULE_MET API Reference

Operations

ROLE

ROLE API Reference

Operations

SALESFORCE_SYNC

SALESFORCE_SYNC API Reference

Operations

SALESFORCE_SYNC_CONF

SALESFORCE_SYNC_CONF API Reference

Operations

SALESFORCE_SYNC_CONFIG

SALESFORCE_SYNC_CONFIG API Reference

Operations

SALESFORCE_SYNC_JOB

SALESFORCE_SYNC_JOB API Reference

Operations

SALESFORCE_SYNC_JOB_ATTACHMENT

SALESFORCE_SYNC_JOB_ATTACHMENT API Reference

Operations

SALESFORCE_SYNC_JOB_FIELD

SALESFORCE_SYNC_JOB_FIELD API Reference

Operations

SALESFORCE_SYNC_JOB_LOG

SALESFORCE_SYNC_JOB_LOG API Reference

Operations

SALESFORCE_SYNC_JOB_MET

SALESFORCE_SYNC_JOB_MET API Reference

Operations

SALESFORCE_SYNC_JOB_SET

SALESFORCE_SYNC_JOB_SET API Reference

Operations

SALESFORCE_SYNC_JOB_SET_ITEM

SALESFORCE_SYNC_JOB_SET_ITEM API Reference

Operations

SALESFORCE_SYNC_OBJECT

SALESFORCE_SYNC_OBJECT API Reference

Operations

SCHEDULER_HOLIDAYS

SCHEDULER_HOLIDAYS API Reference

Operations

SCHEDULER_HOLIDAY_GROUPS

SCHEDULER_HOLIDAY_GROUPS API Reference

Operations

SCHEDULER_JOB

SCHEDULER_JOB API Reference

Operations

SCHEDULER_JOB_EVENT

SCHEDULER_JOB_EVENT API Reference

Operations

SCHEDULER_JOB_LOG

SCHEDULER_JOB_LOG API Reference

Operations

SCHEDULER_SETUP_EMAIL_OVERRIDE

SCHEDULER_SETUP_EMAIL_OVERRIDE API Reference

Operations

SERVICE_PROVIDER

SERVICE_PROVIDER API Reference

Operations

SHARING_GROUP

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_RULE_VALUE

SHARING_GROUP_RULE_VALUE API Reference

Operations

SHARING_GROUP_SQL

SHARING_GROUP_SQL API Reference

Operations

SHARING_GROUP_USER

SHARING_GROUP_USER API Reference

Operations

SINGLE_SIGN_ON

SSO Setup

Operations

SINGLE_SIGN_ON_ATTRIBUTES

SINGLE_SIGN_ON_ATTRIBUTES API Reference

Operations

SMTP_EVENT

SMTP_EVENT API Reference

Operations

SMTP_RELAY_CONFIG

SMTP_RELAY_CONFIG API Reference

Operations

SMTP_RELAY_HEADER

SMTP_RELAY_HEADER API Reference

Operations

SSO_URL_WHITELIST

SSO_URL_WHITELIST API Reference

Operations

SSP_PROFILE

SSP_PROFILE API Reference

Operations

SSP_PROFILE_ITEM

SSP_PROFILE_ITEM API Reference

Operations

STANDARD_RATE_LOADER

STANDARD_RATE_LOADER API Reference

Operations

STANDARD_RATE_LOADER_FIELD

STANDARD_RATE_LOADER_FIELD API Reference

Operations

STANDARD_RATE_LOADER_HISTORY

STANDARD_RATE_LOADER_HISTORY API Reference

Operations

STATEMENT

STATEMENT API Reference

Operations

STATEMENT_GROUP

STATEMENT_GROUP API Reference

Operations

STATEMENT_GROUP_FILTER

STATEMENT_GROUP_FILTER API Reference

Operations

STATEMENT_INVOICE

STATEMENT_INVOICE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

STATEMENT_TRANSACTION

STATEMENT_TRANSACTION API Reference

Operations

SUBSCRIPTION

SUBSCRIPTION API Reference

Operations

SUBSCRIPTION_HISTORY

SUBSCRIPTION_HISTORY API Reference

Operations

SUBSCRIPTION_PAUSE_RECORD

SUBSCRIPTION_PAUSE_RECORD API Reference

Operations

SUPPORT_USERS

SUPPORT_USERS API Reference

Operations

SURCHARGE_CONFIG

SURCHARGE_CONFIG API Reference

Operations

SURETAX_NPA_NXX_TO_GEO_CODE

SURETAX_NPA_NXX_TO_GEO_CODE API Reference

Operations

SURETAX_TRANS_TYPE_CODE

SURETAX_TRANS_TYPE_CODE API Reference

Operations

SURETAX_TRANS_TYPE_CODE_MAP

SURETAX_TRANS_TYPE_CODE_MAP API Reference

Operations

SURETAX_ZIP_CODE_TO_GEO_CODE

SURETAX_ZIP_CODE_TO_GEO_CODE API Reference

Operations

SYSTEM_USAGE_METRIC

SYSTEM_USAGE_METRIC API Reference

Operations

SYSTEM_USAGE_METRICS

SYSTEM_USAGE_METRICS API Reference

Operations

TAX_DETAIL

TAX_DETAIL API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT

TAX_ENGINE_AUDIT API Reference

Operations

TAX_ENGINE_FIELD

TAX_ENGINE_FIELD API Reference

Operations

TAX_ENGINE_TRANSLATION_LOGIC

TAX_ENGINE_TRANSLATION_LOGIC API Reference

Operations

TAX_ENGINE_TRANSL_LOGIC_FIELD

TAX_ENGINE_TRANSL_LOGIC_FIELD API Reference

Operations

TAX_ENGINE_TYPE

TAX_ENGINE_TYPE API Reference

Operations

TAX_EXEMPTION_CODE

TAX_EXEMPTION_CODE API Reference

Operations

TAX_PRODUCT

TAX_PRODUCT API Reference

Operations

TAX_TYPE

TAX_TYPE API Reference

Operations

TIME_ZONE

TIME_ZONE API Reference

Operations

TREE_MENU

TREE_MENU API Reference

Operations

USAGE_IDENTIFIER

USAGE_IDENTIFIER API Reference

Operations

USAGE_MAPPING_VIEW

USAGE_MAPPING_VIEW API Reference

Operations

USER

USER API Reference

Operations

USER_ALERT_SIGNUP

USER_ALERT_SIGNUP API Reference

Operations

USER_HELP_LINK

USER_HELP_LINK API Reference

Operations

WALLET

WALLET API Reference

Operations

WALLET_GATEWAY_DATA

WALLET_GATEWAY_DATA API Reference

Operations

WEB_REQUEST_LOG

WEB_REQUEST_LOG API Reference

Operations

Retrieve By Id Widgets

Request

Get Widgets By Id

Path

idintegerrequired

Id of the record

Headers

sessionIdstringrequired

curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/WIDGET/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "Version": "string",
    "SystemFlag": 0,
    "Token": "string",
    "CompilationStatus": "string",
    "CreatedUserId": "string",
    "Created": "string",
    "EnabledFlag": 0,
    "InteractiveFlag": 0,
    "Updated": "string",
    "UpdatedUserId": "string",
    "ErrorMessage": "string",
    "Id": "string",
    "Html": "string",
    "JavaScript": "string",
    "Compiled": "string",
    "Metadata": "string",
    "Css": "string",
    "WidgetKind": "string",
    "CompiledCss": "string",
    "AccessPermissionItemId": "string",
    "LocalizationVersion": "string"
  }
}

Retrieve Filtered Widgets

Request

Get record(s) using filters

Query

queryAnsiSqlstringrequired

SQL Where part

Headers

sessionIdstringrequired

curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/WIDGET?queryAnsiSql=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "Version": "string",
    "SystemFlag": 0,
    "Token": "string",
    "CompilationStatus": "string",
    "CreatedUserId": "string",
    "Created": "string",
    "EnabledFlag": 0,
    "InteractiveFlag": 0,
    "Updated": "string",
    "UpdatedUserId": "string",
    "ErrorMessage": "string",
    "Id": "string",
    "Html": "string",
    "JavaScript": "string",
    "Compiled": "string",
    "Metadata": "string",
    "Css": "string",
    "WidgetKind": "string",
    "CompiledCss": "string",
    "AccessPermissionItemId": "string",
    "LocalizationVersion": "string"
  }
}

Save Widgets

Request

Save Widgets

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X POST \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/WIDGET \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Version": "string",
      "SystemFlag": 0,
      "Token": "string",
      "CompilationStatus": "string",
      "CreatedUserId": "string",
      "Created": "string",
      "EnabledFlag": 0,
      "InteractiveFlag": 0,
      "Updated": "string",
      "UpdatedUserId": "string",
      "ErrorMessage": "string",
      "Id": "string",
      "Html": "string",
      "JavaScript": "string",
      "Compiled": "string",
      "Metadata": "string",
      "Css": "string",
      "WidgetKind": "string",
      "CompiledCss": "string",
      "AccessPermissionItemId": "string",
      "LocalizationVersion": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "Version": "string",
    "SystemFlag": 0,
    "Token": "string",
    "CompilationStatus": "string",
    "CreatedUserId": "string",
    "Created": "string",
    "EnabledFlag": 0,
    "InteractiveFlag": 0,
    "Updated": "string",
    "UpdatedUserId": "string",
    "ErrorMessage": "string",
    "Id": "string",
    "Html": "string",
    "JavaScript": "string",
    "Compiled": "string",
    "Metadata": "string",
    "Css": "string",
    "WidgetKind": "string",
    "CompiledCss": "string",
    "AccessPermissionItemId": "string",
    "LocalizationVersion": "string"
  }
}

WORKFLOW_ACTION

WORKFLOW_ACTION API Reference

Operations

WORKFLOW_ACTION_ATTACHMENTS

WORKFLOW_ACTION_ATTACHMENTS API Reference

Operations

WORKFLOW_ACTION_HTTP_HEAD

WORKFLOW_ACTION_HTTP_HEAD API Reference

Operations

WORKFLOW_ACTION_HTTP_RESP

WORKFLOW_ACTION_HTTP_RESP API Reference

Operations

WORKFLOW_ACTION_LOG

WORKFLOW_ACTION_LOG API Reference

Operations

WORKFLOW_ACTION_MET

WORKFLOW_ACTION_MET API Reference

Operations

WORKFLOW_DEPENDENCE

WORKFLOW_DEPENDENCE API Reference

Operations

WORKFLOW_RULE

WORKFLOW_RULE API Reference

Operations

WORKFLOW_RULE_MET

WORKFLOW_RULE_MET API Reference

Operations