ENTITY
/
Retrieve By Id Entities

API reference (1.0)

Billing Platform API

Download OpenAPI description
demogm_schema_10_21_2024.json
demogm_schema_10_21_2024.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_schema_10_21_2024/
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

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.

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE

BILLING_PROFILE API Reference

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

Retrieve By Id Entities

Request

Get Entities By Id

Path
idintegerrequired

Id of the record

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

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "CascadeDeleteFlag": "string",
    "BaseEntityId": 0,
    "SystemFlag": 0,
    "RelatedListFlag": "string",
    "LongHelpDiscription": "string",
    "Id": "string",
    "HistoryFlag": "string",
    "ViewEntity": 0,
    "IsApplicationDeployable": 0,
    "Created": "string",
    "CascadePermitionsFlag": "string",
    "RevenueRecognitionEligible": 0,
    "EntityName": "string",
    "LookupEnabledFlag": "string",
    "AfterNode": "string",
    "CreateSearchForm": "string",
    "HistoryRetentionDays": "string",
    "EntityLabel": "string",
    "RetentionDays": "string",
    "RecycleBinFlag": "string",
    "TableName": "string",
    "Widget": 0,
    "ShortHelpLabel": "string",
    "AllowAttributeTable": "string",
    "ApiEnabled": "string",
    "CustomLayout": "string",
    "ParentEntityId": 0,
    "VisibleFlag": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "ExternalHelpTarget": "string",
    "HelpLanguage": "string",
    "CreateDefaultFields": "string",
    "ParentNode": "string",
    "Node": "string",
    "EnableAutoSearch": "string",
    "BaseEntity": "string",
    "ViewFilterLogic": "string",
    "InputForm": "string",
    "LabelId": "string",
    "HideFromTreeMenu": "string"
  }
}

Retrieve Filtered Entities

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_schema_10_21_2024/rest/2.0/ENTITY?queryAnsiSql=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "CascadeDeleteFlag": "string",
    "BaseEntityId": 0,
    "SystemFlag": 0,
    "RelatedListFlag": "string",
    "LongHelpDiscription": "string",
    "Id": "string",
    "HistoryFlag": "string",
    "ViewEntity": 0,
    "IsApplicationDeployable": 0,
    "Created": "string",
    "CascadePermitionsFlag": "string",
    "RevenueRecognitionEligible": 0,
    "EntityName": "string",
    "LookupEnabledFlag": "string",
    "AfterNode": "string",
    "CreateSearchForm": "string",
    "HistoryRetentionDays": "string",
    "EntityLabel": "string",
    "RetentionDays": "string",
    "RecycleBinFlag": "string",
    "TableName": "string",
    "Widget": 0,
    "ShortHelpLabel": "string",
    "AllowAttributeTable": "string",
    "ApiEnabled": "string",
    "CustomLayout": "string",
    "ParentEntityId": 0,
    "VisibleFlag": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "ExternalHelpTarget": "string",
    "HelpLanguage": "string",
    "CreateDefaultFields": "string",
    "ParentNode": "string",
    "Node": "string",
    "EnableAutoSearch": "string",
    "BaseEntity": "string",
    "ViewFilterLogic": "string",
    "InputForm": "string",
    "LabelId": "string",
    "HideFromTreeMenu": "string"
  }
}

Save Entities

Request

Save Entities

Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X POST \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ENTITY \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "CascadeDeleteFlag": "string",
      "BaseEntityId": 0,
      "SystemFlag": 0,
      "RelatedListFlag": "string",
      "LongHelpDiscription": "string",
      "Id": "string",
      "HistoryFlag": "string",
      "ViewEntity": 0,
      "IsApplicationDeployable": 0,
      "Created": "string",
      "CascadePermitionsFlag": "string",
      "RevenueRecognitionEligible": 0,
      "EntityName": "string",
      "LookupEnabledFlag": "string",
      "AfterNode": "string",
      "CreateSearchForm": "string",
      "HistoryRetentionDays": "string",
      "EntityLabel": "string",
      "RetentionDays": "string",
      "RecycleBinFlag": "string",
      "TableName": "string",
      "Widget": 0,
      "ShortHelpLabel": "string",
      "AllowAttributeTable": "string",
      "ApiEnabled": "string",
      "CustomLayout": "string",
      "ParentEntityId": 0,
      "VisibleFlag": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "ExternalHelpTarget": "string",
      "HelpLanguage": "string",
      "CreateDefaultFields": "string",
      "ParentNode": "string",
      "Node": "string",
      "EnableAutoSearch": "string",
      "BaseEntity": "string",
      "ViewFilterLogic": "string",
      "InputForm": "string",
      "LabelId": "string",
      "HideFromTreeMenu": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "CascadeDeleteFlag": "string",
    "BaseEntityId": 0,
    "SystemFlag": 0,
    "RelatedListFlag": "string",
    "LongHelpDiscription": "string",
    "Id": "string",
    "HistoryFlag": "string",
    "ViewEntity": 0,
    "IsApplicationDeployable": 0,
    "Created": "string",
    "CascadePermitionsFlag": "string",
    "RevenueRecognitionEligible": 0,
    "EntityName": "string",
    "LookupEnabledFlag": "string",
    "AfterNode": "string",
    "CreateSearchForm": "string",
    "HistoryRetentionDays": "string",
    "EntityLabel": "string",
    "RetentionDays": "string",
    "RecycleBinFlag": "string",
    "TableName": "string",
    "Widget": 0,
    "ShortHelpLabel": "string",
    "AllowAttributeTable": "string",
    "ApiEnabled": "string",
    "CustomLayout": "string",
    "ParentEntityId": 0,
    "VisibleFlag": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "ExternalHelpTarget": "string",
    "HelpLanguage": "string",
    "CreateDefaultFields": "string",
    "ParentNode": "string",
    "Node": "string",
    "EnableAutoSearch": "string",
    "BaseEntity": "string",
    "ViewFilterLogic": "string",
    "InputForm": "string",
    "LabelId": "string",
    "HideFromTreeMenu": "string"
  }
}

Update Entities

Request

Update Entities

Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ENTITY \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "CascadeDeleteFlag": "string",
      "BaseEntityId": 0,
      "SystemFlag": 0,
      "RelatedListFlag": "string",
      "LongHelpDiscription": "string",
      "Id": "string",
      "HistoryFlag": "string",
      "ViewEntity": 0,
      "IsApplicationDeployable": 0,
      "Created": "string",
      "CascadePermitionsFlag": "string",
      "RevenueRecognitionEligible": 0,
      "EntityName": "string",
      "LookupEnabledFlag": "string",
      "AfterNode": "string",
      "CreateSearchForm": "string",
      "HistoryRetentionDays": "string",
      "EntityLabel": "string",
      "RetentionDays": "string",
      "RecycleBinFlag": "string",
      "TableName": "string",
      "Widget": 0,
      "ShortHelpLabel": "string",
      "AllowAttributeTable": "string",
      "ApiEnabled": "string",
      "CustomLayout": "string",
      "ParentEntityId": 0,
      "VisibleFlag": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "ExternalHelpTarget": "string",
      "HelpLanguage": "string",
      "CreateDefaultFields": "string",
      "ParentNode": "string",
      "Node": "string",
      "EnableAutoSearch": "string",
      "BaseEntity": "string",
      "ViewFilterLogic": "string",
      "InputForm": "string",
      "LabelId": "string",
      "HideFromTreeMenu": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "CascadeDeleteFlag": "string",
    "BaseEntityId": 0,
    "SystemFlag": 0,
    "RelatedListFlag": "string",
    "LongHelpDiscription": "string",
    "Id": "string",
    "HistoryFlag": "string",
    "ViewEntity": 0,
    "IsApplicationDeployable": 0,
    "Created": "string",
    "CascadePermitionsFlag": "string",
    "RevenueRecognitionEligible": 0,
    "EntityName": "string",
    "LookupEnabledFlag": "string",
    "AfterNode": "string",
    "CreateSearchForm": "string",
    "HistoryRetentionDays": "string",
    "EntityLabel": "string",
    "RetentionDays": "string",
    "RecycleBinFlag": "string",
    "TableName": "string",
    "Widget": 0,
    "ShortHelpLabel": "string",
    "AllowAttributeTable": "string",
    "ApiEnabled": "string",
    "CustomLayout": "string",
    "ParentEntityId": 0,
    "VisibleFlag": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "ExternalHelpTarget": "string",
    "HelpLanguage": "string",
    "CreateDefaultFields": "string",
    "ParentNode": "string",
    "Node": "string",
    "EnableAutoSearch": "string",
    "BaseEntity": "string",
    "ViewFilterLogic": "string",
    "InputForm": "string",
    "LabelId": "string",
    "HideFromTreeMenu": "string"
  }
}

Upsert Entities

Request

Upsert Entities

Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
externalIDFieldNamestring
Value"EntityName"
curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/ENTITY \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "CascadeDeleteFlag": "string",
      "BaseEntityId": 0,
      "SystemFlag": 0,
      "RelatedListFlag": "string",
      "LongHelpDiscription": "string",
      "Id": "string",
      "HistoryFlag": "string",
      "ViewEntity": 0,
      "IsApplicationDeployable": 0,
      "Created": "string",
      "CascadePermitionsFlag": "string",
      "RevenueRecognitionEligible": 0,
      "EntityName": "string",
      "LookupEnabledFlag": "string",
      "AfterNode": "string",
      "CreateSearchForm": "string",
      "HistoryRetentionDays": "string",
      "EntityLabel": "string",
      "RetentionDays": "string",
      "RecycleBinFlag": "string",
      "TableName": "string",
      "Widget": 0,
      "ShortHelpLabel": "string",
      "AllowAttributeTable": "string",
      "ApiEnabled": "string",
      "CustomLayout": "string",
      "ParentEntityId": 0,
      "VisibleFlag": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "ExternalHelpTarget": "string",
      "HelpLanguage": "string",
      "CreateDefaultFields": "string",
      "ParentNode": "string",
      "Node": "string",
      "EnableAutoSearch": "string",
      "BaseEntity": "string",
      "ViewFilterLogic": "string",
      "InputForm": "string",
      "LabelId": "string",
      "HideFromTreeMenu": "string"
    },
    "externalIDFieldName": "EntityName"
  }'

Responses

Response with id of updated object

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

Delete Entities

Request

Delete Entities

Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X DELETE \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_schema_10_21_2024/rest/2.0/delete/ENTITY \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "CascadeDeleteFlag": "string",
    "BaseEntityId": 0,
    "SystemFlag": 0,
    "RelatedListFlag": "string",
    "LongHelpDiscription": "string",
    "Id": "string",
    "HistoryFlag": "string",
    "ViewEntity": 0,
    "IsApplicationDeployable": 0,
    "Created": "string",
    "CascadePermitionsFlag": "string",
    "RevenueRecognitionEligible": 0,
    "EntityName": "string",
    "LookupEnabledFlag": "string",
    "AfterNode": "string",
    "CreateSearchForm": "string",
    "HistoryRetentionDays": "string",
    "EntityLabel": "string",
    "RetentionDays": "string",
    "RecycleBinFlag": "string",
    "TableName": "string",
    "Widget": 0,
    "ShortHelpLabel": "string",
    "AllowAttributeTable": "string",
    "ApiEnabled": "string",
    "CustomLayout": "string",
    "ParentEntityId": 0,
    "VisibleFlag": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "ExternalHelpTarget": "string",
    "HelpLanguage": "string",
    "CreateDefaultFields": "string",
    "ParentNode": "string",
    "Node": "string",
    "EnableAutoSearch": "string",
    "BaseEntity": "string",
    "ViewFilterLogic": "string",
    "InputForm": "string",
    "LabelId": "string",
    "HideFromTreeMenu": "string"
  }
}

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

BULK_DATA_LOADER

BULK_DATA_LOADER API Reference

Operations

QUOTE

QUOTE API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT 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