Skip to content
ENTITY_FIELD
/
Save Fields

API Reference (1.0)

Billing Platform API

Download OpenAPI description
demogm_20250725_full_schema.json
demogm_20250725_full_schema.yaml
Overview
URL

http://support.billingplatform.com

API Support

support@billingplatform.com

License

Apache 2.0

Languages
Servers
Mock server

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

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 content.

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

Update Fields

Request

Update Fields

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY_FIELD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ApiAccessableFlag": null,
      "ApiHiddenFlag": null,
      "AttributeColumnFlag": null,
      "BaseEntityId": null,
      "ConditionGroupId": null,
      "Created": null,
      "CreatedUserId": null,
      "CrosslinkFlag": null,
      "CurrencyDate": null,
      "CurrencySource": null,
      "DataLength": null,
      "DataType": null,
      "DefaultValue": null,
      "Description": null,
      "DisplayAfter": null,
      "DisplayNew": null,
      "DisplayType": null,
      "DisplayUpdate": null,
      "DisplayView": null,
      "EncryptedFlag": null,
      "EntityId": null,
      "ExternalKey": null,
      "ExternalKeyFlag": null,
      "FieldLabel": null,
      "FieldName": null,
      "FormulaValue": null,
      "FunctionBasedField": null,
      "FunctionBasedFunction": null,
      "Guid": null,
      "HelpContentLong": null,
      "HelpContentShort": null,
      "HelpLanguageCode": null,
      "HiddenFlag": null,
      "Id": null,
      "IgnoreOnEdit": null,
      "InstantTypeAheadSearch": null,
      "ItemPosition": null,
      "LabelId": null,
      "LongHelpLabelId": null,
      "LookupFieldName": null,
      "LoopFlag": null,
      "ModifyFuncName": null,
      "OnDelete": null,
      "PIIFlag": null,
      "PkSequenceName": null,
      "PricingAttributeId": null,
      "PrimaryKeyFlag": null,
      "ReactComponentFlag": null,
      "ReferencedColumn": null,
      "ReferencedEntityId": null,
      "RelatedEntityId": null,
      "RelatedListFilterLogic": null,
      "RelatedListRecrdsPerPage": null,
      "RelatedWebFormId": null,
      "RelationPath": null,
      "RequiredFlag": null,
      "RestrictChangeInClosedAP": null,
      "RestrictCreate": null,
      "SearchableFlag": null,
      "SequenceFilterLogic": null,
      "SequenceFormula": null,
      "SequenceIncrementBy": null,
      "SequenceNumberOfDigits": null,
      "SequencePrefix": null,
      "SequenceRuleCriteria": null,
      "SequenceStartingNumber": null,
      "SequenceSuffix": null,
      "ShortHelpLabelId": null,
      "Status": null,
      "SystemFlag": null,
      "SystemGeneratedFlag": null,
      "UniqueField": null,
      "Updated": null,
      "UpdatedUserId": null,
      "ViewRelationshipField": null,
      "WebFormItemId": null
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
updateResponseArray of objects
Response
application/json
{
  "updateResponse": [
    { … }
  ]
}

Save Fields

Request

Save Fields

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X POST \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY_FIELD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ApiAccessableFlag": null,
      "ApiHiddenFlag": null,
      "AttributeColumnFlag": null,
      "BaseEntityId": null,
      "ConditionGroupId": null,
      "Created": null,
      "CreatedUserId": null,
      "CrosslinkFlag": null,
      "CurrencyDate": null,
      "CurrencySource": null,
      "DataLength": null,
      "DataType": null,
      "DefaultValue": null,
      "Description": null,
      "DisplayAfter": null,
      "DisplayNew": null,
      "DisplayType": null,
      "DisplayUpdate": null,
      "DisplayView": null,
      "EncryptedFlag": null,
      "EntityId": null,
      "ExternalKey": null,
      "ExternalKeyFlag": null,
      "FieldLabel": null,
      "FieldName": null,
      "FormulaValue": null,
      "FunctionBasedField": null,
      "FunctionBasedFunction": null,
      "Guid": null,
      "HelpContentLong": null,
      "HelpContentShort": null,
      "HelpLanguageCode": null,
      "HiddenFlag": null,
      "Id": null,
      "IgnoreOnEdit": null,
      "InstantTypeAheadSearch": null,
      "ItemPosition": null,
      "LabelId": null,
      "LongHelpLabelId": null,
      "LookupFieldName": null,
      "LoopFlag": null,
      "ModifyFuncName": null,
      "OnDelete": null,
      "PIIFlag": null,
      "PkSequenceName": null,
      "PricingAttributeId": null,
      "PrimaryKeyFlag": null,
      "ReactComponentFlag": null,
      "ReferencedColumn": null,
      "ReferencedEntityId": null,
      "RelatedEntityId": null,
      "RelatedListFilterLogic": null,
      "RelatedListRecrdsPerPage": null,
      "RelatedWebFormId": null,
      "RelationPath": null,
      "RequiredFlag": null,
      "RestrictChangeInClosedAP": null,
      "RestrictCreate": null,
      "SearchableFlag": null,
      "SequenceFilterLogic": null,
      "SequenceFormula": null,
      "SequenceIncrementBy": null,
      "SequenceNumberOfDigits": null,
      "SequencePrefix": null,
      "SequenceRuleCriteria": null,
      "SequenceStartingNumber": null,
      "SequenceSuffix": null,
      "ShortHelpLabelId": null,
      "Status": null,
      "SystemFlag": null,
      "SystemGeneratedFlag": null,
      "UniqueField": null,
      "Updated": null,
      "UpdatedUserId": null,
      "ViewRelationshipField": null,
      "WebFormItemId": null
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
createResponseArray of objects
Response
application/json
{
  "createResponse": [
    { … }
  ]
}

Upsert Fields

Request

Upsert Fields

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
externalIDFieldNamestring
Value"ExternalKey"
curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY_FIELD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ApiAccessableFlag": null,
      "ApiHiddenFlag": null,
      "AttributeColumnFlag": null,
      "BaseEntityId": null,
      "ConditionGroupId": null,
      "Created": null,
      "CreatedUserId": null,
      "CrosslinkFlag": null,
      "CurrencyDate": null,
      "CurrencySource": null,
      "DataLength": null,
      "DataType": null,
      "DefaultValue": null,
      "Description": null,
      "DisplayAfter": null,
      "DisplayNew": null,
      "DisplayType": null,
      "DisplayUpdate": null,
      "DisplayView": null,
      "EncryptedFlag": null,
      "EntityId": null,
      "ExternalKey": null,
      "ExternalKeyFlag": null,
      "FieldLabel": null,
      "FieldName": null,
      "FormulaValue": null,
      "FunctionBasedField": null,
      "FunctionBasedFunction": null,
      "Guid": null,
      "HelpContentLong": null,
      "HelpContentShort": null,
      "HelpLanguageCode": null,
      "HiddenFlag": null,
      "Id": null,
      "IgnoreOnEdit": null,
      "InstantTypeAheadSearch": null,
      "ItemPosition": null,
      "LabelId": null,
      "LongHelpLabelId": null,
      "LookupFieldName": null,
      "LoopFlag": null,
      "ModifyFuncName": null,
      "OnDelete": null,
      "PIIFlag": null,
      "PkSequenceName": null,
      "PricingAttributeId": null,
      "PrimaryKeyFlag": null,
      "ReactComponentFlag": null,
      "ReferencedColumn": null,
      "ReferencedEntityId": null,
      "RelatedEntityId": null,
      "RelatedListFilterLogic": null,
      "RelatedListRecrdsPerPage": null,
      "RelatedWebFormId": null,
      "RelationPath": null,
      "RequiredFlag": null,
      "RestrictChangeInClosedAP": null,
      "RestrictCreate": null,
      "SearchableFlag": null,
      "SequenceFilterLogic": null,
      "SequenceFormula": null,
      "SequenceIncrementBy": null,
      "SequenceNumberOfDigits": null,
      "SequencePrefix": null,
      "SequenceRuleCriteria": null,
      "SequenceStartingNumber": null,
      "SequenceSuffix": null,
      "ShortHelpLabelId": null,
      "Status": null,
      "SystemFlag": null,
      "SystemGeneratedFlag": null,
      "UniqueField": null,
      "Updated": null,
      "UpdatedUserId": null,
      "ViewRelationshipField": null,
      "WebFormItemId": null
    },
    "externalIDFieldName": "ExternalKey"
  }'

Responses

Response with id of updated object

Bodyapplication/json
upsertResponseArray of objects
Response
application/json
{
  "upsertResponse": [
    { … }
  ]
}

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

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 content.

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

Update Fields

Request

Update Fields

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY_FIELD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ApiAccessableFlag": null,
      "ApiHiddenFlag": null,
      "AttributeColumnFlag": null,
      "BaseEntityId": null,
      "ConditionGroupId": null,
      "Created": null,
      "CreatedUserId": null,
      "CrosslinkFlag": null,
      "CurrencyDate": null,
      "CurrencySource": null,
      "DataLength": null,
      "DataType": null,
      "DefaultValue": null,
      "Description": null,
      "DisplayAfter": null,
      "DisplayNew": null,
      "DisplayType": null,
      "DisplayUpdate": null,
      "DisplayView": null,
      "EncryptedFlag": null,
      "EntityId": null,
      "ExternalKey": null,
      "ExternalKeyFlag": null,
      "FieldLabel": null,
      "FieldName": null,
      "FormulaValue": null,
      "FunctionBasedField": null,
      "FunctionBasedFunction": null,
      "Guid": null,
      "HelpContentLong": null,
      "HelpContentShort": null,
      "HelpLanguageCode": null,
      "HiddenFlag": null,
      "Id": null,
      "IgnoreOnEdit": null,
      "InstantTypeAheadSearch": null,
      "ItemPosition": null,
      "LabelId": null,
      "LongHelpLabelId": null,
      "LookupFieldName": null,
      "LoopFlag": null,
      "ModifyFuncName": null,
      "OnDelete": null,
      "PIIFlag": null,
      "PkSequenceName": null,
      "PricingAttributeId": null,
      "PrimaryKeyFlag": null,
      "ReactComponentFlag": null,
      "ReferencedColumn": null,
      "ReferencedEntityId": null,
      "RelatedEntityId": null,
      "RelatedListFilterLogic": null,
      "RelatedListRecrdsPerPage": null,
      "RelatedWebFormId": null,
      "RelationPath": null,
      "RequiredFlag": null,
      "RestrictChangeInClosedAP": null,
      "RestrictCreate": null,
      "SearchableFlag": null,
      "SequenceFilterLogic": null,
      "SequenceFormula": null,
      "SequenceIncrementBy": null,
      "SequenceNumberOfDigits": null,
      "SequencePrefix": null,
      "SequenceRuleCriteria": null,
      "SequenceStartingNumber": null,
      "SequenceSuffix": null,
      "ShortHelpLabelId": null,
      "Status": null,
      "SystemFlag": null,
      "SystemGeneratedFlag": null,
      "UniqueField": null,
      "Updated": null,
      "UpdatedUserId": null,
      "ViewRelationshipField": null,
      "WebFormItemId": null
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
updateResponseArray of objects
Response
application/json
{
  "updateResponse": [
    { … }
  ]
}

Save Fields

Request

Save Fields

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X POST \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY_FIELD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ApiAccessableFlag": null,
      "ApiHiddenFlag": null,
      "AttributeColumnFlag": null,
      "BaseEntityId": null,
      "ConditionGroupId": null,
      "Created": null,
      "CreatedUserId": null,
      "CrosslinkFlag": null,
      "CurrencyDate": null,
      "CurrencySource": null,
      "DataLength": null,
      "DataType": null,
      "DefaultValue": null,
      "Description": null,
      "DisplayAfter": null,
      "DisplayNew": null,
      "DisplayType": null,
      "DisplayUpdate": null,
      "DisplayView": null,
      "EncryptedFlag": null,
      "EntityId": null,
      "ExternalKey": null,
      "ExternalKeyFlag": null,
      "FieldLabel": null,
      "FieldName": null,
      "FormulaValue": null,
      "FunctionBasedField": null,
      "FunctionBasedFunction": null,
      "Guid": null,
      "HelpContentLong": null,
      "HelpContentShort": null,
      "HelpLanguageCode": null,
      "HiddenFlag": null,
      "Id": null,
      "IgnoreOnEdit": null,
      "InstantTypeAheadSearch": null,
      "ItemPosition": null,
      "LabelId": null,
      "LongHelpLabelId": null,
      "LookupFieldName": null,
      "LoopFlag": null,
      "ModifyFuncName": null,
      "OnDelete": null,
      "PIIFlag": null,
      "PkSequenceName": null,
      "PricingAttributeId": null,
      "PrimaryKeyFlag": null,
      "ReactComponentFlag": null,
      "ReferencedColumn": null,
      "ReferencedEntityId": null,
      "RelatedEntityId": null,
      "RelatedListFilterLogic": null,
      "RelatedListRecrdsPerPage": null,
      "RelatedWebFormId": null,
      "RelationPath": null,
      "RequiredFlag": null,
      "RestrictChangeInClosedAP": null,
      "RestrictCreate": null,
      "SearchableFlag": null,
      "SequenceFilterLogic": null,
      "SequenceFormula": null,
      "SequenceIncrementBy": null,
      "SequenceNumberOfDigits": null,
      "SequencePrefix": null,
      "SequenceRuleCriteria": null,
      "SequenceStartingNumber": null,
      "SequenceSuffix": null,
      "ShortHelpLabelId": null,
      "Status": null,
      "SystemFlag": null,
      "SystemGeneratedFlag": null,
      "UniqueField": null,
      "Updated": null,
      "UpdatedUserId": null,
      "ViewRelationshipField": null,
      "WebFormItemId": null
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
createResponseArray of objects
Response
application/json
{
  "createResponse": [
    { … }
  ]
}

Upsert Fields

Request

Upsert Fields

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
externalIDFieldNamestring
Value"ExternalKey"
curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/ENTITY_FIELD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ApiAccessableFlag": null,
      "ApiHiddenFlag": null,
      "AttributeColumnFlag": null,
      "BaseEntityId": null,
      "ConditionGroupId": null,
      "Created": null,
      "CreatedUserId": null,
      "CrosslinkFlag": null,
      "CurrencyDate": null,
      "CurrencySource": null,
      "DataLength": null,
      "DataType": null,
      "DefaultValue": null,
      "Description": null,
      "DisplayAfter": null,
      "DisplayNew": null,
      "DisplayType": null,
      "DisplayUpdate": null,
      "DisplayView": null,
      "EncryptedFlag": null,
      "EntityId": null,
      "ExternalKey": null,
      "ExternalKeyFlag": null,
      "FieldLabel": null,
      "FieldName": null,
      "FormulaValue": null,
      "FunctionBasedField": null,
      "FunctionBasedFunction": null,
      "Guid": null,
      "HelpContentLong": null,
      "HelpContentShort": null,
      "HelpLanguageCode": null,
      "HiddenFlag": null,
      "Id": null,
      "IgnoreOnEdit": null,
      "InstantTypeAheadSearch": null,
      "ItemPosition": null,
      "LabelId": null,
      "LongHelpLabelId": null,
      "LookupFieldName": null,
      "LoopFlag": null,
      "ModifyFuncName": null,
      "OnDelete": null,
      "PIIFlag": null,
      "PkSequenceName": null,
      "PricingAttributeId": null,
      "PrimaryKeyFlag": null,
      "ReactComponentFlag": null,
      "ReferencedColumn": null,
      "ReferencedEntityId": null,
      "RelatedEntityId": null,
      "RelatedListFilterLogic": null,
      "RelatedListRecrdsPerPage": null,
      "RelatedWebFormId": null,
      "RelationPath": null,
      "RequiredFlag": null,
      "RestrictChangeInClosedAP": null,
      "RestrictCreate": null,
      "SearchableFlag": null,
      "SequenceFilterLogic": null,
      "SequenceFormula": null,
      "SequenceIncrementBy": null,
      "SequenceNumberOfDigits": null,
      "SequencePrefix": null,
      "SequenceRuleCriteria": null,
      "SequenceStartingNumber": null,
      "SequenceSuffix": null,
      "ShortHelpLabelId": null,
      "Status": null,
      "SystemFlag": null,
      "SystemGeneratedFlag": null,
      "UniqueField": null,
      "Updated": null,
      "UpdatedUserId": null,
      "ViewRelationshipField": null,
      "WebFormItemId": null
    },
    "externalIDFieldName": "ExternalKey"
  }'

Responses

Response with id of updated object

Bodyapplication/json
upsertResponseArray of objects
Response
application/json
{
  "upsertResponse": [
    { … }
  ]
}

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