Update Payments

CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT API Reference

Operations

CONTRACT_RATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_RATE API Reference

Operations

COUNTRY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE_MAP API Reference

Operations

DESTINATION_COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

LABEL_VERSION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

LABEL_VERSION API Reference

Operations

LANGUAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

PACKAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE API Reference

Operations

PACKAGE_CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE_PRODUCT API Reference

Operations

PARENT_PACKAGE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

PRICING
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PRICING API Reference

Operations

PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Configure the Products in your product catalog

Operations

RATE_CLASS
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATE_CLASS API Reference

Operations

RATE_CLASS_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATING_METHOD API Reference

Operations

ACCOUNT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Account short help content.

Operations

ACCOUNT_PACKAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PRODUCT_QUOTE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT API Reference

Operations

CONTRACT_CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_RATE API Reference

Operations

COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE_MAP API Reference

Operations

CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CURRENCY API Reference

Operations

PRICING
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PRICING API Reference

Operations

SHARING_GROUP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP_USER API Reference

Operations

TIME_ZONE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TIME_ZONE API Reference

Operations

ACTIVITY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACTIVITY API Reference

Operations

ACTIVITY_COLLECTOR
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACTIVITY_COLLECTOR API Reference

Operations

BILLING_IDENTIFIER
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COLLECTOR_FIELDS API Reference

Operations

CREDIT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT API Reference

Operations

CREDIT_ALLOCATION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT_ALLOCATION API Reference

Operations

CREDIT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

DUNNING_INTERVAL API Reference

Operations

INVOICE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE API Reference

Operations

INVOICE_TEMPLATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE_TEMPLATE API Reference

Operations

PAYMENT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT API Reference

Operations

Save Payments

Request

Save Payments

Security

JWT

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X POST \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PAYMENT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "PaymentDate": "string",
      "PaymentType": "string",
      "Autoallocate": 0,
      "BillingProfileId": 0,
      "Created": "string",
      "InvoiceIdDisplay": "string",
      "ExternalReferenceId": "string",
      "Id": "string",
      "UpdatedUserId": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "CreditCardExpDate": "string",
      "CreditCardName": "string",
      "CreditCardNumber": "string",
      "CreditCardCCV": "string",
      "CreditCardTransactionMessage": "string",
      "VoidWithoutGateway": 0,
      "PendingAmount": "string",
      "CreditCardType": "string",
      "AchBankAcctNum": "string",
      "Address1": "string",
      "City": "string",
      "State": "string",
      "Country": "string",
      "Zip": "string",
      "VoidedPaymentId": 0,
      "GatewayTransactionId": "string",
      "EcomTransactionResponseId": 0,
      "EcomTransactionId": 0,
      "PaymentGatewayProfileId": 0,
      "VoidFlag": "string",
      "LockboxRecordId": 0,
      "SourcePaymentId": 0,
      "PaymentAllocationStrategy": "string",
      "AllocatedToExtAccount": "string",
      "SinglePaymentGroup": "string",
      "ApproveInvoiceId": 0,
      "GatewayTransactionStatus": "string",
      "GatewayTransactionStatusDate": "string",
      "PayoutId": "string",
      "CreditCardToken": "string",
      "WalletId": 0,
      "LateApprovedBy": 0,
      "OperatorId": "string",
      "AccountingPeriodId": 0,
      "AchToken": "string",
      "HostedPaymentPageExternalId": "string",
      "BpPayoutId": 0,
      "AutomaticPayment": 0,
      "PaymentCreditAllocationMethod": "string",
      "TaxAllocation": "string",
      "PaStrategyIds": "string",
      "PaymentNote": "string",
      "CreditCardTransactionStatus": "string",
      "CheckNumber": "string",
      "CreditCardTransactionStatusCode": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "PaymentDate": "string",
    "PaymentType": "string",
    "Autoallocate": 0,
    "BillingProfileId": 0,
    "Created": "string",
    "InvoiceIdDisplay": "string",
    "ExternalReferenceId": "string",
    "Id": "string",
    "UpdatedUserId": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "CreditCardExpDate": "string",
    "CreditCardName": "string",
    "CreditCardNumber": "string",
    "CreditCardCCV": "string",
    "CreditCardTransactionMessage": "string",
    "VoidWithoutGateway": 0,
    "PendingAmount": "string",
    "CreditCardType": "string",
    "AchBankAcctNum": "string",
    "Address1": "string",
    "City": "string",
    "State": "string",
    "Country": "string",
    "Zip": "string",
    "VoidedPaymentId": 0,
    "GatewayTransactionId": "string",
    "EcomTransactionResponseId": 0,
    "EcomTransactionId": 0,
    "PaymentGatewayProfileId": 0,
    "VoidFlag": "string",
    "LockboxRecordId": 0,
    "SourcePaymentId": 0,
    "PaymentAllocationStrategy": "string",
    "AllocatedToExtAccount": "string",
    "SinglePaymentGroup": "string",
    "ApproveInvoiceId": 0,
    "GatewayTransactionStatus": "string",
    "GatewayTransactionStatusDate": "string",
    "PayoutId": "string",
    "CreditCardToken": "string",
    "WalletId": 0,
    "LateApprovedBy": 0,
    "OperatorId": "string",
    "AccountingPeriodId": 0,
    "AchToken": "string",
    "HostedPaymentPageExternalId": "string",
    "BpPayoutId": 0,
    "AutomaticPayment": 0,
    "PaymentCreditAllocationMethod": "string",
    "TaxAllocation": "string",
    "PaStrategyIds": "string",
    "PaymentNote": "string",
    "CreditCardTransactionStatus": "string",
    "CheckNumber": "string",
    "CreditCardTransactionStatusCode": "string"
  }
}

Update Payments

Request

Update Payments

Security

JWT

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PAYMENT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "PaymentDate": "string",
      "PaymentType": "string",
      "Autoallocate": 0,
      "BillingProfileId": 0,
      "Created": "string",
      "InvoiceIdDisplay": "string",
      "ExternalReferenceId": "string",
      "Id": "string",
      "UpdatedUserId": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "CreditCardExpDate": "string",
      "CreditCardName": "string",
      "CreditCardNumber": "string",
      "CreditCardCCV": "string",
      "CreditCardTransactionMessage": "string",
      "VoidWithoutGateway": 0,
      "PendingAmount": "string",
      "CreditCardType": "string",
      "AchBankAcctNum": "string",
      "Address1": "string",
      "City": "string",
      "State": "string",
      "Country": "string",
      "Zip": "string",
      "VoidedPaymentId": 0,
      "GatewayTransactionId": "string",
      "EcomTransactionResponseId": 0,
      "EcomTransactionId": 0,
      "PaymentGatewayProfileId": 0,
      "VoidFlag": "string",
      "LockboxRecordId": 0,
      "SourcePaymentId": 0,
      "PaymentAllocationStrategy": "string",
      "AllocatedToExtAccount": "string",
      "SinglePaymentGroup": "string",
      "ApproveInvoiceId": 0,
      "GatewayTransactionStatus": "string",
      "GatewayTransactionStatusDate": "string",
      "PayoutId": "string",
      "CreditCardToken": "string",
      "WalletId": 0,
      "LateApprovedBy": 0,
      "OperatorId": "string",
      "AccountingPeriodId": 0,
      "AchToken": "string",
      "HostedPaymentPageExternalId": "string",
      "BpPayoutId": 0,
      "AutomaticPayment": 0,
      "PaymentCreditAllocationMethod": "string",
      "TaxAllocation": "string",
      "PaStrategyIds": "string",
      "PaymentNote": "string",
      "CreditCardTransactionStatus": "string",
      "CheckNumber": "string",
      "CreditCardTransactionStatusCode": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "PaymentDate": "string",
    "PaymentType": "string",
    "Autoallocate": 0,
    "BillingProfileId": 0,
    "Created": "string",
    "InvoiceIdDisplay": "string",
    "ExternalReferenceId": "string",
    "Id": "string",
    "UpdatedUserId": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "CreditCardExpDate": "string",
    "CreditCardName": "string",
    "CreditCardNumber": "string",
    "CreditCardCCV": "string",
    "CreditCardTransactionMessage": "string",
    "VoidWithoutGateway": 0,
    "PendingAmount": "string",
    "CreditCardType": "string",
    "AchBankAcctNum": "string",
    "Address1": "string",
    "City": "string",
    "State": "string",
    "Country": "string",
    "Zip": "string",
    "VoidedPaymentId": 0,
    "GatewayTransactionId": "string",
    "EcomTransactionResponseId": 0,
    "EcomTransactionId": 0,
    "PaymentGatewayProfileId": 0,
    "VoidFlag": "string",
    "LockboxRecordId": 0,
    "SourcePaymentId": 0,
    "PaymentAllocationStrategy": "string",
    "AllocatedToExtAccount": "string",
    "SinglePaymentGroup": "string",
    "ApproveInvoiceId": 0,
    "GatewayTransactionStatus": "string",
    "GatewayTransactionStatusDate": "string",
    "PayoutId": "string",
    "CreditCardToken": "string",
    "WalletId": 0,
    "LateApprovedBy": 0,
    "OperatorId": "string",
    "AccountingPeriodId": 0,
    "AchToken": "string",
    "HostedPaymentPageExternalId": "string",
    "BpPayoutId": 0,
    "AutomaticPayment": 0,
    "PaymentCreditAllocationMethod": "string",
    "TaxAllocation": "string",
    "PaStrategyIds": "string",
    "PaymentNote": "string",
    "CreditCardTransactionStatus": "string",
    "CheckNumber": "string",
    "CreditCardTransactionStatusCode": "string"
  }
}

Upsert Payments

Request

Upsert Payments

Security

JWT

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

externalIDFieldNamestring

Value"HostedPaymentPageExternalId"

curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PAYMENT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "PaymentDate": "string",
      "PaymentType": "string",
      "Autoallocate": 0,
      "BillingProfileId": 0,
      "Created": "string",
      "InvoiceIdDisplay": "string",
      "ExternalReferenceId": "string",
      "Id": "string",
      "UpdatedUserId": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "CreditCardExpDate": "string",
      "CreditCardName": "string",
      "CreditCardNumber": "string",
      "CreditCardCCV": "string",
      "CreditCardTransactionMessage": "string",
      "VoidWithoutGateway": 0,
      "PendingAmount": "string",
      "CreditCardType": "string",
      "AchBankAcctNum": "string",
      "Address1": "string",
      "City": "string",
      "State": "string",
      "Country": "string",
      "Zip": "string",
      "VoidedPaymentId": 0,
      "GatewayTransactionId": "string",
      "EcomTransactionResponseId": 0,
      "EcomTransactionId": 0,
      "PaymentGatewayProfileId": 0,
      "VoidFlag": "string",
      "LockboxRecordId": 0,
      "SourcePaymentId": 0,
      "PaymentAllocationStrategy": "string",
      "AllocatedToExtAccount": "string",
      "SinglePaymentGroup": "string",
      "ApproveInvoiceId": 0,
      "GatewayTransactionStatus": "string",
      "GatewayTransactionStatusDate": "string",
      "PayoutId": "string",
      "CreditCardToken": "string",
      "WalletId": 0,
      "LateApprovedBy": 0,
      "OperatorId": "string",
      "AccountingPeriodId": 0,
      "AchToken": "string",
      "HostedPaymentPageExternalId": "string",
      "BpPayoutId": 0,
      "AutomaticPayment": 0,
      "PaymentCreditAllocationMethod": "string",
      "TaxAllocation": "string",
      "PaStrategyIds": "string",
      "PaymentNote": "string",
      "CreditCardTransactionStatus": "string",
      "CheckNumber": "string",
      "CreditCardTransactionStatusCode": "string"
    },
    "externalIDFieldName": "HostedPaymentPageExternalId"
  }'

Responses

Response with id of updated object

Bodyapplication/json

upsertResponseArray of objects

Response

application/json

{
  "upsertResponse": [
    { … }
  ]
}

REFUND
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REFUND API Reference

Operations

REFUND_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REFUND_TYPE API Reference

Operations

TAX_DETAIL
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_DETAIL API Reference

Operations

TAX_ENGINE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_CONTACT API Reference

Operations

CONTACT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTACT_TYPE API Reference

Operations

CS_ACCOUNT_ACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACCOUNT_ACTION API Reference

Operations

CS_ACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACTION API Reference

Operations

CS_ACTION_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_STRATEGY API Reference

Operations

INVOICE_WALLET
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

GENERAL_LEDGER_TRANSACTION API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REVREC_CONTRACT API Reference

Operations

ENTITY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY API Reference

Operations

ENTITY_FIELD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ROLE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD_ROLE API Reference

Operations

ENTITY_FIELD_VALUES
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD_VALUES API Reference

Operations

QUOTE_DRAFT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_DRAFT API Reference

Operations

QUOTE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE API Reference

Operations

QUOTE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE API Reference

Operations

CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT API Reference

Operations

CONTRACT_RATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_RATE API Reference

Operations

COUNTRY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE_MAP API Reference

Operations

DESTINATION_COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

LABEL_VERSION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

LABEL_VERSION API Reference

Operations

LANGUAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

PACKAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE API Reference

Operations

PACKAGE_CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE_PRODUCT API Reference

Operations

PARENT_PACKAGE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

PRICING
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PRICING API Reference

Operations

PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Configure the Products in your product catalog

Operations

RATE_CLASS
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATE_CLASS API Reference

Operations

RATE_CLASS_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATING_METHOD API Reference

Operations

ACCOUNT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Account short help content.

Operations

ACCOUNT_PACKAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PRODUCT_QUOTE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

Operations

CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT API Reference

Operations

CONTRACT_CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_RATE API Reference

Operations

COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE_MAP API Reference

Operations

CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CURRENCY API Reference

Operations

PRICING
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PRICING API Reference

Operations

SHARING_GROUP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP_USER API Reference

Operations

TIME_ZONE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TIME_ZONE API Reference

Operations

ACTIVITY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACTIVITY API Reference

Operations

ACTIVITY_COLLECTOR
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACTIVITY_COLLECTOR API Reference

Operations

BILLING_IDENTIFIER
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COLLECTOR_FIELDS API Reference

Operations

CREDIT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT API Reference

Operations

CREDIT_ALLOCATION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT_ALLOCATION API Reference

Operations

CREDIT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

DUNNING_INTERVAL API Reference

Operations

INVOICE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE API Reference

Operations

INVOICE_TEMPLATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE_TEMPLATE API Reference

Operations

PAYMENT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT API Reference

Operations

Save Payments

Request

Save Payments

Security

JWT

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X POST \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PAYMENT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "PaymentDate": "string",
      "PaymentType": "string",
      "Autoallocate": 0,
      "BillingProfileId": 0,
      "Created": "string",
      "InvoiceIdDisplay": "string",
      "ExternalReferenceId": "string",
      "Id": "string",
      "UpdatedUserId": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "CreditCardExpDate": "string",
      "CreditCardName": "string",
      "CreditCardNumber": "string",
      "CreditCardCCV": "string",
      "CreditCardTransactionMessage": "string",
      "VoidWithoutGateway": 0,
      "PendingAmount": "string",
      "CreditCardType": "string",
      "AchBankAcctNum": "string",
      "Address1": "string",
      "City": "string",
      "State": "string",
      "Country": "string",
      "Zip": "string",
      "VoidedPaymentId": 0,
      "GatewayTransactionId": "string",
      "EcomTransactionResponseId": 0,
      "EcomTransactionId": 0,
      "PaymentGatewayProfileId": 0,
      "VoidFlag": "string",
      "LockboxRecordId": 0,
      "SourcePaymentId": 0,
      "PaymentAllocationStrategy": "string",
      "AllocatedToExtAccount": "string",
      "SinglePaymentGroup": "string",
      "ApproveInvoiceId": 0,
      "GatewayTransactionStatus": "string",
      "GatewayTransactionStatusDate": "string",
      "PayoutId": "string",
      "CreditCardToken": "string",
      "WalletId": 0,
      "LateApprovedBy": 0,
      "OperatorId": "string",
      "AccountingPeriodId": 0,
      "AchToken": "string",
      "HostedPaymentPageExternalId": "string",
      "BpPayoutId": 0,
      "AutomaticPayment": 0,
      "PaymentCreditAllocationMethod": "string",
      "TaxAllocation": "string",
      "PaStrategyIds": "string",
      "PaymentNote": "string",
      "CreditCardTransactionStatus": "string",
      "CheckNumber": "string",
      "CreditCardTransactionStatusCode": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "PaymentDate": "string",
    "PaymentType": "string",
    "Autoallocate": 0,
    "BillingProfileId": 0,
    "Created": "string",
    "InvoiceIdDisplay": "string",
    "ExternalReferenceId": "string",
    "Id": "string",
    "UpdatedUserId": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "CreditCardExpDate": "string",
    "CreditCardName": "string",
    "CreditCardNumber": "string",
    "CreditCardCCV": "string",
    "CreditCardTransactionMessage": "string",
    "VoidWithoutGateway": 0,
    "PendingAmount": "string",
    "CreditCardType": "string",
    "AchBankAcctNum": "string",
    "Address1": "string",
    "City": "string",
    "State": "string",
    "Country": "string",
    "Zip": "string",
    "VoidedPaymentId": 0,
    "GatewayTransactionId": "string",
    "EcomTransactionResponseId": 0,
    "EcomTransactionId": 0,
    "PaymentGatewayProfileId": 0,
    "VoidFlag": "string",
    "LockboxRecordId": 0,
    "SourcePaymentId": 0,
    "PaymentAllocationStrategy": "string",
    "AllocatedToExtAccount": "string",
    "SinglePaymentGroup": "string",
    "ApproveInvoiceId": 0,
    "GatewayTransactionStatus": "string",
    "GatewayTransactionStatusDate": "string",
    "PayoutId": "string",
    "CreditCardToken": "string",
    "WalletId": 0,
    "LateApprovedBy": 0,
    "OperatorId": "string",
    "AccountingPeriodId": 0,
    "AchToken": "string",
    "HostedPaymentPageExternalId": "string",
    "BpPayoutId": 0,
    "AutomaticPayment": 0,
    "PaymentCreditAllocationMethod": "string",
    "TaxAllocation": "string",
    "PaStrategyIds": "string",
    "PaymentNote": "string",
    "CreditCardTransactionStatus": "string",
    "CheckNumber": "string",
    "CreditCardTransactionStatusCode": "string"
  }
}

Update Payments

Request

Update Payments

Security

JWT

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PAYMENT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "PaymentDate": "string",
      "PaymentType": "string",
      "Autoallocate": 0,
      "BillingProfileId": 0,
      "Created": "string",
      "InvoiceIdDisplay": "string",
      "ExternalReferenceId": "string",
      "Id": "string",
      "UpdatedUserId": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "CreditCardExpDate": "string",
      "CreditCardName": "string",
      "CreditCardNumber": "string",
      "CreditCardCCV": "string",
      "CreditCardTransactionMessage": "string",
      "VoidWithoutGateway": 0,
      "PendingAmount": "string",
      "CreditCardType": "string",
      "AchBankAcctNum": "string",
      "Address1": "string",
      "City": "string",
      "State": "string",
      "Country": "string",
      "Zip": "string",
      "VoidedPaymentId": 0,
      "GatewayTransactionId": "string",
      "EcomTransactionResponseId": 0,
      "EcomTransactionId": 0,
      "PaymentGatewayProfileId": 0,
      "VoidFlag": "string",
      "LockboxRecordId": 0,
      "SourcePaymentId": 0,
      "PaymentAllocationStrategy": "string",
      "AllocatedToExtAccount": "string",
      "SinglePaymentGroup": "string",
      "ApproveInvoiceId": 0,
      "GatewayTransactionStatus": "string",
      "GatewayTransactionStatusDate": "string",
      "PayoutId": "string",
      "CreditCardToken": "string",
      "WalletId": 0,
      "LateApprovedBy": 0,
      "OperatorId": "string",
      "AccountingPeriodId": 0,
      "AchToken": "string",
      "HostedPaymentPageExternalId": "string",
      "BpPayoutId": 0,
      "AutomaticPayment": 0,
      "PaymentCreditAllocationMethod": "string",
      "TaxAllocation": "string",
      "PaStrategyIds": "string",
      "PaymentNote": "string",
      "CreditCardTransactionStatus": "string",
      "CheckNumber": "string",
      "CreditCardTransactionStatusCode": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "PaymentDate": "string",
    "PaymentType": "string",
    "Autoallocate": 0,
    "BillingProfileId": 0,
    "Created": "string",
    "InvoiceIdDisplay": "string",
    "ExternalReferenceId": "string",
    "Id": "string",
    "UpdatedUserId": "string",
    "Updated": "string",
    "CreatedUserId": "string",
    "CreditCardExpDate": "string",
    "CreditCardName": "string",
    "CreditCardNumber": "string",
    "CreditCardCCV": "string",
    "CreditCardTransactionMessage": "string",
    "VoidWithoutGateway": 0,
    "PendingAmount": "string",
    "CreditCardType": "string",
    "AchBankAcctNum": "string",
    "Address1": "string",
    "City": "string",
    "State": "string",
    "Country": "string",
    "Zip": "string",
    "VoidedPaymentId": 0,
    "GatewayTransactionId": "string",
    "EcomTransactionResponseId": 0,
    "EcomTransactionId": 0,
    "PaymentGatewayProfileId": 0,
    "VoidFlag": "string",
    "LockboxRecordId": 0,
    "SourcePaymentId": 0,
    "PaymentAllocationStrategy": "string",
    "AllocatedToExtAccount": "string",
    "SinglePaymentGroup": "string",
    "ApproveInvoiceId": 0,
    "GatewayTransactionStatus": "string",
    "GatewayTransactionStatusDate": "string",
    "PayoutId": "string",
    "CreditCardToken": "string",
    "WalletId": 0,
    "LateApprovedBy": 0,
    "OperatorId": "string",
    "AccountingPeriodId": 0,
    "AchToken": "string",
    "HostedPaymentPageExternalId": "string",
    "BpPayoutId": 0,
    "AutomaticPayment": 0,
    "PaymentCreditAllocationMethod": "string",
    "TaxAllocation": "string",
    "PaStrategyIds": "string",
    "PaymentNote": "string",
    "CreditCardTransactionStatus": "string",
    "CheckNumber": "string",
    "CreditCardTransactionStatusCode": "string"
  }
}

Upsert Payments

Request

Upsert Payments

Security

JWT

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

externalIDFieldNamestring

Value"HostedPaymentPageExternalId"

curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/PAYMENT \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "PaymentDate": "string",
      "PaymentType": "string",
      "Autoallocate": 0,
      "BillingProfileId": 0,
      "Created": "string",
      "InvoiceIdDisplay": "string",
      "ExternalReferenceId": "string",
      "Id": "string",
      "UpdatedUserId": "string",
      "Updated": "string",
      "CreatedUserId": "string",
      "CreditCardExpDate": "string",
      "CreditCardName": "string",
      "CreditCardNumber": "string",
      "CreditCardCCV": "string",
      "CreditCardTransactionMessage": "string",
      "VoidWithoutGateway": 0,
      "PendingAmount": "string",
      "CreditCardType": "string",
      "AchBankAcctNum": "string",
      "Address1": "string",
      "City": "string",
      "State": "string",
      "Country": "string",
      "Zip": "string",
      "VoidedPaymentId": 0,
      "GatewayTransactionId": "string",
      "EcomTransactionResponseId": 0,
      "EcomTransactionId": 0,
      "PaymentGatewayProfileId": 0,
      "VoidFlag": "string",
      "LockboxRecordId": 0,
      "SourcePaymentId": 0,
      "PaymentAllocationStrategy": "string",
      "AllocatedToExtAccount": "string",
      "SinglePaymentGroup": "string",
      "ApproveInvoiceId": 0,
      "GatewayTransactionStatus": "string",
      "GatewayTransactionStatusDate": "string",
      "PayoutId": "string",
      "CreditCardToken": "string",
      "WalletId": 0,
      "LateApprovedBy": 0,
      "OperatorId": "string",
      "AccountingPeriodId": 0,
      "AchToken": "string",
      "HostedPaymentPageExternalId": "string",
      "BpPayoutId": 0,
      "AutomaticPayment": 0,
      "PaymentCreditAllocationMethod": "string",
      "TaxAllocation": "string",
      "PaStrategyIds": "string",
      "PaymentNote": "string",
      "CreditCardTransactionStatus": "string",
      "CheckNumber": "string",
      "CreditCardTransactionStatusCode": "string"
    },
    "externalIDFieldName": "HostedPaymentPageExternalId"
  }'

Responses

Response with id of updated object

Bodyapplication/json

upsertResponseArray of objects

Response

application/json

{
  "upsertResponse": [
    { … }
  ]
}

REFUND
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REFUND API Reference

Operations

REFUND_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REFUND_TYPE API Reference

Operations

TAX_DETAIL
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_DETAIL API Reference

Operations

TAX_ENGINE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_CONTACT API Reference

Operations

CONTACT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTACT_TYPE API Reference

Operations

CS_ACCOUNT_ACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACCOUNT_ACTION API Reference

Operations

CS_ACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACTION API Reference

Operations

CS_ACTION_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_STRATEGY API Reference

Operations

INVOICE_WALLET
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

GENERAL_LEDGER_TRANSACTION API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REVREC_CONTRACT API Reference

Operations

ENTITY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY API Reference

Operations

ENTITY_FIELD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ROLE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD_ROLE API Reference

Operations

ENTITY_FIELD_VALUES
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD_VALUES API Reference

Operations

QUOTE_DRAFT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_DRAFT API Reference

Operations

QUOTE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE API Reference

Operations

QUOTE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE API Reference

Operations

API Reference (1.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CONTRACTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CONTRACT_RATECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

COUNTRYCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

COUNTRY_CODE_MAPCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

DESTINATION_COUNTRY_CODECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

LABEL_VERSIONCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

LANGUAGECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ORIGINATION_COUNTRY_CODECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PACKAGECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PACKAGE_CURRENCYCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PACKAGE_PRODUCTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PARENT_PACKAGE_PRODUCTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PRICINGCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PRODUCTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

RATE_CLASSCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

RATE_CLASS_PRODUCTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

RATING_METHODCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ACCOUNTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ACCOUNT_PACKAGECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ACCOUNT_PRODUCTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ACCOUNT_PRODUCT_QUOTECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

BILLING_PROFILECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CONTRACTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CONTRACT_CURRENCYCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CONTRACT_RATECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

COUNTRY_CODECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

COUNTRY_CODE_MAPCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CURRENCYCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PRICINGCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SHARING_GROUPCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SHARING_GROUP_RULECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SHARING_GROUP_USERCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TIME_ZONECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ACTIVITYCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ACTIVITY_COLLECTORCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

BILLING_IDENTIFIERCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

COLLECTOR_FIELDSCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CREDITCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CREDIT_ALLOCATIONCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CREDIT_TYPECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

DUNNING_INTERVALCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

INVOICECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

INVOICE_TEMPLATECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PAYMENTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Save Payments

RequestExpand all

Responses

Was this helpful?

Update Payments

RequestExpand all

Responses

Was this helpful?

Upsert Payments

RequestExpand all

Responses

Was this helpful?

REFUNDCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

REFUND_TYPECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TAX_DETAILCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TAX_ENGINECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TAX_ENGINE_AUDITCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ACCOUNT_CONTACTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CONTACT_TYPECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CS_ACCOUNT_ACTIONCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CS_ACTIONCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CS_ACTION_TYPECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CS_STRATEGYCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

INVOICE_WALLETCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PAYMENT_ALLOCATIONCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PAYMENT_TYPECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

STATEMENT_TEMPLATECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

GENERAL_LEDGER_TRANSACTIONCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PROCESS_QUEUE_REVENUE_COMMITMENTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

REVREC_CONTRACTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ENTITYCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ENTITY_FIELDCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ENTITY_FIELD_ROLECopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ENTITY_FIELD_VALUESCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

QUOTE_DRAFTCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

API Reference (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_RATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE_MAP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

DESTINATION_COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

LABEL_VERSION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

LANGUAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ORIGINATION_COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE_CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PACKAGE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PARENT_PACKAGE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PRICING
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATE_CLASS
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATE_CLASS_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

RATING_METHOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PACKAGE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_PRODUCT_QUOTE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

BILLING_PROFILE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_RATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE_MAP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CURRENCY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PRICING
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP_RULE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SHARING_GROUP_USER
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TIME_ZONE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACTIVITY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACTIVITY_COLLECTOR
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

BILLING_IDENTIFIER
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COLLECTOR_FIELDS
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT_ALLOCATION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CREDIT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

DUNNING_INTERVAL
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE_TEMPLATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Request

Request

REFUND
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REFUND_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_DETAIL
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE_AUDIT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ACCOUNT_CONTACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTACT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACCOUNT_ACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_ACTION_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CS_STRATEGY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

INVOICE_WALLET
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT_ALLOCATION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PAYMENT_TYPE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

STATEMENT_TEMPLATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

GENERAL_LEDGER_TRANSACTION
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

PROCESS_QUEUE_REVENUE_COMMITMENT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

REVREC_CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD_ROLE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ENTITY_FIELD_VALUES
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_DRAFT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PRODUCT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PERIOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

QUOTE_PRODUCT_PERIOD
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

TAX_ENGINE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

CONTRACT_RATE
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

COUNTRY_CODE_MAP
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude