Note: There is a newer version (0.1.1) of this package available. Click here to view docs for the latest version.

Modules

pricefx

Module pricefx

ballerinax/pricefx Ballerina library

0.1.0

Overview

Pricefx is a cloud-native pricing and revenue management platform that helps enterprises manage price lists, calculation grids, quotes, contracts, and rebate agreements across their sales organization.

The ballerinax/pricefx connector offers APIs to connect and interact with the Pricefx Backend API, covering all 477 publicly exposed operations across master data (products, customers, sellers), pricing (price lists, manual price lists, calculation grids, condition records), sales (quotes, contracts, rebates, sales compensations), and platform administration (users, workflow, data manager, notifications, comments, custom forms, and more).

Setup guide

Authentication goes in ConnectionConfig.auth, typed as pricefx:PricefxCredentials — a union of four records, one per method. You pick the record matching the credentials you hold, and the compiler holds you to it: an incomplete or mixed-up combination will not compile.

BasicCredentials — username, password, partition. The connector authenticates once with HTTP Basic auth and then reuses the X-PriceFx-jwt session token Pricefx hands back, so the deliberate ~500 ms penalty Pricefx applies to Basic auth is paid once per client rather than on every request. If a deployment returns no session token, it falls back to Basic auth per request.
OAuth2Credentials — clientId, refreshToken, and optionally clientSecret. The refresh token must be obtained once beforehand through Pricefx's Authorization Code Grant flow, which needs an interactive browser redirect and so can't be automated by this connector. Once you have one, access tokens are fetched and renewed automatically.
JwtCredentials — jwt. Sent as-is via X-PriceFx-jwt, with nothing exchanged, so creating the client makes no network call. This is the option for the non-expiring integration tokens minted by generateJwtToken. The connector cannot refresh a token supplied this way (it holds no credentials to re-authenticate with), which is fine for a non-expiring token but not for a short-lived session one.
ExternalJwtCredentials — systemName, jwt, if your organization has a trust relationship configured on the Pricefx side (externalJWTConfiguration) with an external system that signs JWTs on your behalf.

Anything Pricefx needs that is not authentication — a two-factor code (PriceFx-TFA), a CSRF token (X-PriceFx-Csrf-Token), or a header a specific endpoint expects — is passed per call, since every operation takes an optional headers argument:


oas:ListPriceListsResponse result = check pricefxClient->listPriceLists({}, {"PriceFx-TFA": "123456"});

There is deliberately no configuration field for a two-factor code: it expires in about thirty seconds, so it cannot usefully live in configuration, and the connector has no way to regenerate one. Interactive two-factor auth does not really suit unattended integrations anyway — prefer JwtCredentials or OAuth 2.0 there.

The connector automatically re-authenticates and retries once whenever a request comes back unauthenticated (session tokens and OAuth2 access tokens are short-lived), so a long-lived pricefx:Client instance keeps working without manual re-initialization.

Quickstart

To use the pricefx connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module


import ballerina/io;
import ballerinax/pricefx;
import ballerinax/pricefx.oas;

Step 2: Instantiate a new connector

Create a Config.toml file with your Pricefx credentials:


username = "<your-pricefx-username>"
password = "<your-pricefx-password>"
partition = "<your-partition>"
serviceUrl = "https://<your-node>.pricefx.com/pricefx/<your-partition>"

Create a pricefx:Client instance:


configurable string username = ?;
configurable string password = ?;
configurable string partition = ?;
configurable string serviceUrl = ?;

final pricefx:Client pricefxClient = check new ({auth: {username, password, partition}}, serviceUrl);

Constructing the client makes one Basic authenticated call to obtain a session token; every request after that uses the token. To use a different method, supply its record as auth instead — see the setup guide above. For example, with a non-expiring integration JWT:


final pricefx:Client pricefxClient = check new ({auth: {jwt}}, serviceUrl);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

List all price lists


public function main() returns error? {
    oas:ListPriceListsRequest payload = {};
    oas:ListPriceListsResponse response = check pricefxClient->listPriceLists(payload);
    io:println(response);
}

Step 4: Run the Ballerina application


bal run

Examples

The Pricefx connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

Product catalog management — Add a new product to the catalog, update one of its fields, then list matching products to confirm the change.
Customer quote workflow — Add a new customer, create a quote for them, then submit the quote for approval.
Price list calculation — Create a new price list, run its calculation, then fetch the calculated price list.
Attachment upload workflow — Create an upload slot for a customer record, upload a file to it, then list the customer's files.

Build from the source

Setting up the prerequisites

Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:
- Oracle JDK
- OpenJDK
Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.
Download and install Ballerina Swan Lake.
Download and install Docker.

Note: Ensure that the Docker daemon is running before executing any tests.

Export Github Personal access token with read package permissions as follows,


export packageUser=<Username>
export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

To build the package:


./gradlew clean build

To run the tests:


./gradlew clean test

To build the without the tests:


./gradlew clean build -x test

To run tests against different environments:


./gradlew clean test -Pgroups=<Comma separated groups/test cases>

To debug the package with a remote debugger:


./gradlew clean build -Pdebug=<port>

To debug with the Ballerina language:


./gradlew clean build -PbalJavaDebug=<port>

Publish the generated artifacts to the local Ballerina Central repository:


./gradlew clean build -PpublishToLocalCentral=true

Publish the generated artifacts to the Ballerina Central repository:


./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

For more information go to the pricefx package.
For example demonstrations of the usage, go to Ballerina By Examples.
Chat live with us via our Discord server.
Post all technical questions on Stack Overflow with the #ballerina tag.

Clients

pricefx: Client

Isolated

The ballerinax/pricefx client. Wraps the generated oas client - kept as pristine, regeneratable code in the oas submodule - and adds the two things Pricefx's API needs that a generated client cannot provide: turning PricefxCredentials into the right kind of HTTP auth, and transparently re-authenticating and replaying a request once when it comes back unauthenticated. Session tokens and OAuth2 access tokens are short-lived, so that retry is what lets a long-lived client instance keep working without manual re-initialization.

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector. config.auth selects the authentication method - see PricefxCredentials

serviceUrl string "https://companynode.pricefx.com/pricefx/companypartition" - URL of the target service

acceptCalculationGridItem

Isolated FunctionRemote Function

function acceptCalculationGridItem(string id, SubmitCalculationGridItemRequest payload, map<string|string[]> headers) returns SubmitCalculationGridItemResponse|error

Submit a Calculation Grid Item

Parameters

id string - The id of the Calculation Grid you want to submit items for. You can retrieve the id of the CG, for example, by calling the /fetch/CG endpoint

payload SubmitCalculationGridItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmitCalculationGridItemResponse|error - OK

addActionType

Isolated FunctionRemote Function

function addActionType(AddActionTypeRequest payload, map<string|string[]> headers) returns AddActionTypeResponse|error

Add an Action Type

Parameters

payload AddActionTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddActionTypeResponse|error - OK

addApproverStep

Isolated FunctionRemote Function

function addApproverStep(string currentStepId, AddApproverStepRequest payload, map<string|string[]> headers) returns AddApproverStepResponse|error

Add an Approver Step

Parameters

currentStepId string - The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint

payload AddApproverStepRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddApproverStepResponse|error - OK

addCalculation

Isolated FunctionRemote Function

function addCalculation(AddCalculationRequest payload, map<string|string[]> headers) returns AddCalculationResponse|error

Add a Calculation

Parameters

payload AddCalculationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddCalculationResponse|error - OK

addCalculationGrid

Isolated FunctionRemote Function

function addCalculationGrid(AddCalculationGridRequest payload, map<string|string[]> headers) returns AddCalculationGridResponse|error

Add a Calculation Grid

Parameters

payload AddCalculationGridRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddCalculationGridResponse|error - OK

addCalculationGridItem

Isolated FunctionRemote Function

function addCalculationGridItem("1"|"2"|"3"|"4"|"5"|"6"  keyNumber, AddCalculationGridItemRequest payload, map<string|string[]> headers) returns AddCalculationGridItemResponse|error

Add a Calculation Grid Item

Parameters

keyNumber "1"|"2"|"3"|"4"|"5"|"6" - Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys

payload AddCalculationGridItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddCalculationGridItemResponse|error - OK

addClaim

Isolated FunctionRemote Function

function addClaim(AddClaimRequest payload, map<string|string[]> headers) returns AddClaimResponse|error

Add a Claim

Parameters

payload AddClaimRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddClaimResponse|error - OK

addClaimType

Isolated FunctionRemote Function

function addClaimType(AddClaimTypeRequest payload, map<string|string[]> headers) returns AddClaimTypeResponse|error

Add a Claim Type

Parameters

payload AddClaimTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddClaimTypeResponse|error - OK

addComment

Isolated FunctionRemote Function

function addComment(CommentmanagerAddBody payload, map<string|string[]> headers) returns CommentOperationEnvelope|error

Add a Comment

Parameters

payload CommentmanagerAddBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CommentOperationEnvelope|error - OK

addCompensationType

Isolated FunctionRemote Function

function addCompensationType(AddCompensationTypeRequest payload, map<string|string[]> headers) returns AddCompensationTypeEnvelope|error

Add a Compensation Type

Parameters

payload AddCompensationTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddCompensationTypeEnvelope|error - OK

addConditionRecordItemMeta

Isolated FunctionRemote Function

function addConditionRecordItemMeta(AddCRCIMBody payload, map<string|string[]> headers) returns ConditionRecordItemMetaOperationEnvelope|error

Add a Condition Record Item Attribute Meta

Parameters

payload AddCRCIMBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordItemMetaOperationEnvelope|error - OK

addConditionRecordSet

Isolated FunctionRemote Function

function addConditionRecordSet(AddCRCSBody payload, map<string|string[]> headers) returns ConditionRecordSetOperationEnvelope|error

Add a Condition Record Set

Parameters

payload AddCRCSBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordSetOperationEnvelope|error - OK

addConditionType

Isolated FunctionRemote Function

function addConditionType(AddConditionTypeRequest payload, map<string|string[]> headers) returns AddConditionTypeEnvelope|error

Add a Condition Type

Parameters

payload AddConditionTypeRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddConditionTypeEnvelope|error - OK

addConfigurationStorage

Isolated FunctionRemote Function

function addConfigurationStorage(AddJCSBody payload, map<string|string[]> headers) returns ConfigurationStorageOperationEnvelope|error

Add a Configuration Storage

Parameters

payload AddJCSBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConfigurationStorageOperationEnvelope|error - OK

addContractLineItems

Isolated FunctionRemote Function

function addContractLineItems(AddContractLineItemsRequest payload, map<string|string[]> headers) returns ContractModelResponse|error

Add Contract Line Items

Parameters

payload AddContractLineItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ContractModelResponse|error - Example response

addCustomer

Isolated FunctionRemote Function

function addCustomer(AddCustomerRequest payload, map<string|string[]> headers) returns CustomerResponse|error

Add a Customer

Parameters

payload AddCustomerRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomerResponse|error - Returns customer record details

addDataChangeRequest

Isolated FunctionRemote Function

function addDataChangeRequest(AddDCRRequest payload, map<string|string[]> headers) returns AddDCRResponse|error

Add a Data Change Request

Parameters

payload AddDCRRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddDCRResponse|error - OK

addDataChangeRequestItem

Isolated FunctionRemote Function

function addDataChangeRequestItem(string id, AddDCRIRequest payload, map<string|string[]> headers) returns AddDCRIResponse|error

Add a Data Change Request Item

Parameters

id string - id of the Data Change Request you want to add the Data Change Request Item to

payload AddDCRIRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddDCRIResponse|error - OK

addLineItems

Isolated FunctionRemote Function

function addLineItems(string typedId, ClicmanagerAdditemstypedIdBody payload, map<string|string[]> headers) returns record {}|error

Add Line Items

Parameters

typedId string - typed ID of the target CLIC document

payload ClicmanagerAdditemstypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

record {}|error - OK

addLivePriceGridType

Isolated FunctionRemote Function

function addLivePriceGridType(AddPGTTBody payload, map<string|string[]> headers) returns LivePriceGridTypeOperationEnvelope|error

Add a Live Price Grid Type

Parameters

payload AddPGTTBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LivePriceGridTypeOperationEnvelope|error - OK

addLookupTable

Isolated FunctionRemote Function

function addLookupTable(AddLookupTableRequest payload, map<string|string[]> headers) returns AddLookupTableResponse|error

Add a Lookup Table

Parameters

payload AddLookupTableRequest - The request must contain all fields that are part of the business key for that object and all non-nullable fields

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddLookupTableResponse|error - OK

addLookupTableValue

Isolated FunctionRemote Function

function addLookupTableValue(string tableId, AddLookupTableValueRequest payload, map<string|string[]> headers) returns AddLookupTableValueResponse|error

Add a Lookup Table Value

Parameters

tableId string - Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method

payload AddLookupTableValueRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddLookupTableValueResponse|error - OK

addManualPriceListProducts

Isolated FunctionRemote Function

function addManualPriceListProducts(string id, AddProductsToManualPriceListRequest payload, map<string|string[]> headers) returns GenericDataResponse|error

Add Products to a Manual Pricelist

Parameters

id string - The ID of the Manual Price List where you want to add products to

payload AddProductsToManualPriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

addManualPriceListProductsNoRecalc

Isolated FunctionRemote Function

function addManualPriceListProductsNoRecalc(string id, AddProductsToManualPriceListNoRecalcRequest payload, map<string|string[]> headers) returns AddProductsToManualPriceListNoRecalcResponse|error

Add Products to a Manual Price List (No Recalculation)

Parameters

id string - The ID of the Manual Price List where you want to add products to

payload AddProductsToManualPriceListNoRecalcRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddProductsToManualPriceListNoRecalcResponse|error - OK

addNewInternationalizationMessage

Isolated FunctionRemote Function

function addNewInternationalizationMessage(I18nmanagerPutBody payload, map<string|string[]> headers) returns AddInternationalizationMessageEnvelope|error

Add a New Internationalization Message

Parameters

payload I18nmanagerPutBody -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddInternationalizationMessageEnvelope|error - Created - the new internationalization messages have been added

addPriceGridItemsToPriceGrid

Isolated FunctionRemote Function

function addPriceGridItemsToPriceGrid(string id, AddPriceGridItemsRequest payload, map<string|string[]> headers) returns AddPriceGridItemsToPriceGridResponse|error

Add Price Grid Items to a Price Grid

Parameters

id string - The ID of the Live Price Grid where you want to add Price Grid Items to. id is the typedId without PG suffix. For example, the id attribute of the item with typedId = 649.PG is 649. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

payload AddPriceGridItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddPriceGridItemsToPriceGridResponse|error - OK

addPriceListType

Isolated FunctionRemote Function

function addPriceListType(AddPLTTBody payload, map<string|string[]> headers) returns PriceListTypeOperationEnvelope|error

Add a Price List Type

Parameters

payload AddPLTTBody -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceListTypeOperationEnvelope|error - OK

addProduct

Isolated FunctionRemote Function

function addProduct(AddProductRequest payload, map<string|string[]> headers) returns ProductResponse|error

Add a Product

Parameters

payload AddProductRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

addQuoteProducts

Isolated FunctionRemote Function

function addQuoteProducts(AddProductsToQuoteRequest payload, map<string|string[]> headers) returns QuoteResponse|error

Add Products to a Quote

Parameters

payload AddProductsToQuoteRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

addRebateAgreementItems

Isolated FunctionRemote Function

function addRebateAgreementItems(GetCustomerRequest payload, map<string|string[]> headers) returns RebateAgreementResponse|error

Add Rebate Agreement Items

Parameters

payload GetCustomerRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RebateAgreementResponse|error - Example response

addRebateCalculation

Isolated FunctionRemote Function

function addRebateCalculation(AddRRSCBody payload, map<string|string[]> headers) returns AddRebateCalculationResponse|error

Add a Rebate Calculation

Parameters

payload AddRRSCBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddRebateCalculationResponse|error - OK

addSeller

Isolated FunctionRemote Function

function addSeller(AddSellerRequest payload, map<string|string[]> headers) returns AddSellerEnvelope|error

Add a Seller

Parameters

payload AddSellerRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddSellerEnvelope|error - OK

addSellerExtension

Isolated FunctionRemote Function

function addSellerExtension(AddSellerExtensionRequest payload, map<string|string[]> headers) returns AddSellerExtensionResponse|error

Add a Seller Extension

Parameters

payload AddSellerExtensionRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddSellerExtensionResponse|error - OK

addUser

Isolated FunctionRemote Function

function addUser(AddUserRequest payload, map<string|string[]> headers) returns UserResponse|error

Add a User

Parameters

payload AddUserRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UserResponse|error - Example response

addWatcherStep

Isolated FunctionRemote Function

function addWatcherStep(string currentStepId, AddWatcherStepRequest payload, map<string|string[]> headers) returns AddWatcherStepResponse|error

Add a Watcher Step

Parameters

currentStepId string - The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint

payload AddWatcherStepRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddWatcherStepResponse|error - OK

approveDocument

Isolated FunctionRemote Function

function approveDocument(string currentStepId, ApproveDocumentRequest payload, map<string|string[]> headers) returns ApproveDocumentResponse|error

Approve a Document

Parameters

currentStepId string - The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint

payload ApproveDocumentRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ApproveDocumentResponse|error - OK

assignBusinessRole

Isolated FunctionRemote Function

function assignBusinessRole(AssignBusinessRoleRequest payload, map<string|string[]> headers) returns AssignBusinessRoleResponse|error

Assign a Business Role

Parameters

payload AssignBusinessRoleRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignBusinessRoleResponse|error - OK

assignBusinessRoleToUser

Isolated FunctionRemote Function

function assignBusinessRoleToUser(string userId, AssignBusinessRoleToUserRequest payload, map<string|string[]> headers) returns AssignBusinessRoleToUserResponse|error

Assign a Business Role to a User

Parameters

userId string - The ID of the user you want to assign a role to. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

payload AssignBusinessRoleToUserRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignBusinessRoleToUserResponse|error - OK

assignCustomers

Isolated FunctionRemote Function

function assignCustomers(AssignCustomersRequest payload, map<string|string[]> headers) returns AssignmentResponse|error

Assign Customers

Parameters

payload AssignCustomersRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignmentResponse|error - Example response

assignGroupToBusinessRole

Isolated FunctionRemote Function

function assignGroupToBusinessRole(AssignGroupToBusinessRoleRequest payload, map<string|string[]> headers) returns AssignGroupToBusinessRoleResponse|error

Assign a Group to a Business Role

Parameters

payload AssignGroupToBusinessRoleRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignGroupToBusinessRoleResponse|error - OK

assignRoleToBusinessRole

Isolated FunctionRemote Function

function assignRoleToBusinessRole(AssignRoleToBusinessRoleRequest payload, map<string|string[]> headers) returns AssignRoleToBusinessRoleResponse|error

Assign a Role to a Business Role

Parameters

payload AssignRoleToBusinessRoleRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignRoleToBusinessRoleResponse|error - OK

assignRoleToUser

Isolated FunctionRemote Function

function assignRoleToUser(string userId, AssignRoleToUserRequest payload, map<string|string[]> headers) returns AssignRoleToUserResponse|error

Assign a Role to a User

Parameters

userId string - The ID of the user you want to assign a role to. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

payload AssignRoleToUserRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignRoleToUserResponse|error - OK

assignRoleToUsers

Isolated FunctionRemote Function

function assignRoleToUsers(AssignRoleToUsersRequest payload, map<string|string[]> headers) returns AssignRoleToUsersResponse|error

Assign a Role to Users

Parameters

payload AssignRoleToUsersRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignRoleToUsersResponse|error - OK

assignUserGroupToUsers

Isolated FunctionRemote Function

function assignUserGroupToUsers(AssignUserGroupToUsersRequest payload, map<string|string[]> headers) returns AssignUserGroupToUsersResponse|error

Assign a User Group to Users

Parameters

payload AssignUserGroupToUsersRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignUserGroupToUsersResponse|error - OK

assignUserToUserGroup

Isolated FunctionRemote Function

function assignUserToUserGroup(string userId, AssignUserToUserGroupRequest payload, map<string|string[]> headers) returns AssignUserToUserGroupResponse|error

Assign a User to a User Group

Parameters

userId string - The ID of the user you want to add to the group. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

payload AssignUserToUserGroupRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignUserToUserGroupResponse|error - OK

bulkInsertCustomers

Isolated FunctionRemote Function

function bulkInsertCustomers(InsertBulkCustomersRequest payload, map<string|string[]> headers) returns LoadDataResponse|error

Insert Bulk Customers

Parameters

payload InsertBulkCustomersRequest - Specify customer field names in the header object and fields values in the data object.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LoadDataResponse|error - Returns the number of inserted or updated objects

bulkInsertProducts

Isolated FunctionRemote Function

function bulkInsertProducts(InsertBulkProductsRequest payload, map<string|string[]> headers) returns LoadDataResponse|error

Insert Bulk Products

Parameters

payload InsertBulkProductsRequest - Specify product field names in the header object and fields values in the data object.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LoadDataResponse|error - Returns the number of inserted or updated objects

calculateCalculationGrid

Isolated FunctionRemote Function

function calculateCalculationGrid(string id, CalculateCalculationGridRequest payload, map<string|string[]> headers) returns CalculateCalculationGridResponse|error

Calculate a Calculation Grid

Parameters

id string - id of the Calculation Grid you want to calculate

payload CalculateCalculationGridRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CalculateCalculationGridResponse|error - OK

calculateCfs

Isolated FunctionRemote Function

function calculateCfs(string id, map<string|string[]> headers) returns CalculateCFSResponse|error

Calculate a CFS

Parameters

id string - The id is the typedId without the type suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CalculateCFSResponse|error - OK

calculateClaim

Isolated FunctionRemote Function

function calculateClaim(string typedId, CalculateClaimRequest payload, map<string|string[]> headers) returns CalculateClaimResponse|error

Calculate a Claim

Parameters

typedId string - The typedId of the claim whose items you want to calculate

payload CalculateClaimRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CalculateClaimResponse|error - OK

calculateManualPriceList

Isolated FunctionRemote Function

function calculateManualPriceList(string id, map<string|string[]> headers) returns CalculateManualPriceListResponse|error

Calculate a Manual Price List

Parameters

id string - The ID of the Manual Price List you want to start the calculation for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CalculateManualPriceListResponse|error - OK

calculateModelObjectStep

Isolated FunctionRemote Function

function calculateModelObjectStep(string typedId, "definition"|"configuration"|"results"|"projections"|"parallel"  stepName, map<string|string[]> headers, *CalculateModelObjectStepQueries queries) returns ModelCalculationStepEnvelope|error

Calculate a Model Object Step

Parameters

typedId string - The typedId of the Model Object you want to recalculate the step for

stepName "definition"|"configuration"|"results"|"projections"|"parallel" - Enter the name of the step you want to calculate

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CalculateModelObjectStepQueries - Queries to be sent with the request

Return Type

ModelCalculationStepEnvelope|error - OK

calculatePriceGrid

Isolated FunctionRemote Function

function calculatePriceGrid(string id, map<string|string[]> headers) returns CalculatePriceGridResponse|error

Calculate a Price Grid

Parameters

id string - The id to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CalculatePriceGridResponse|error - OK

calculatePriceList

Isolated FunctionRemote Function

function calculatePriceList(string id, PricelistmanagerCalculateidBody payload, map<string|string[]> headers) returns CalculatePricelistResponse|error

Calculate a Pricelist

Parameters

id string - The ID of the Price List you want to calculate. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

payload PricelistmanagerCalculateidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CalculatePricelistResponse|error - OK

calculateRebateRecordGroup

Isolated FunctionRemote Function

function calculateRebateRecordGroup(string typedId, RebaterecordgroupCalculatetypedIdBody payload, map<string|string[]> headers) returns CalculateRebateRecordGroupEnvelope|error

Calculate a Rebate Record Group

Parameters

typedId string - typedId of the Rebate Record Group you want to calculate

payload RebaterecordgroupCalculatetypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CalculateRebateRecordGroupEnvelope|error - OK

cancelCalculationStep

Isolated FunctionRemote Function

function cancelCalculationStep(string typedId, string stepName, map<string|string[]> headers) returns JobStatusTrackerResponse|error

Cancel a Calculation Step

Parameters

typedId string - The typedId of the Model Object you want to cancel the calculation step for

stepName string - The name of the step you want to cancel

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobStatusTrackerResponse|error - Example response

cancelCfsCalculation

Isolated FunctionRemote Function

function cancelCfsCalculation(string id, map<string|string[]> headers) returns GenericDataResponse|error

Cancel a CFS Calculation

Parameters

id string - The id is the typedId without the type suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

cancelClaimCalculation

Isolated FunctionRemote Function

function cancelClaimCalculation(string typedId, record {} payload, map<string|string[]> headers) returns CancelClaimCalculationResponse|error

Cancel a Calculation

Parameters

typedId string - The typedId of the claim whose item calculation you want to cancel

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CancelClaimCalculationResponse|error - OK

cancelJob

Isolated FunctionRemote Function

function cancelJob(string id, record {} payload, map<string|string[]> headers) returns GenericDataResponse|error

Cancel a Job

Parameters

id string - id if the job you want to cancel

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

cancelPriceGridCalculation

Isolated FunctionRemote Function

function cancelPriceGridCalculation(string id, map<string|string[]> headers) returns CancelCalculationResponse|error

Cancel a Calculation

Parameters

id string - The ID of the Live Price Grid whose running calculation should be cancelled

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CancelCalculationResponse|error - OK

changeCurrentUserPassword

Isolated FunctionRemote Function

function changeCurrentUserPassword(ChangeCurrentUserPasswordRequest payload, map<string|string[]> headers) returns ChangeCurrentUserPasswordResponse|error

Change a Current User Password

Parameters

payload ChangeCurrentUserPasswordRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ChangeCurrentUserPasswordResponse|error - OK

changeCustomFormStatus

Isolated FunctionRemote Function

function changeCustomFormStatus(string typedId, ChangeCustomFormStatusRequest payload, map<string|string[]> headers) returns ChangeCustomFormStatusResponse|error

Change a Custom Form Status

Parameters

typedId string - The typedId of the Custom Form whose status you want to change

payload ChangeCustomFormStatusRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ChangeCustomFormStatusResponse|error - OK

changeTermsOfUse

DeprecatedIsolated FunctionRemote Function

function changeTermsOfUse(AccountmanagerChangetermsofuseBody payload, map<string|string[]> headers) returns Response|error

Change Terms of Use

Parameters

payload AccountmanagerChangetermsofuseBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - No Content

Deprecated

changeUserPassword

Isolated FunctionRemote Function

function changeUserPassword(string userId, ChangeUserPasswordRequest payload, map<string|string[]> headers) returns ChangeUserPasswordResponse|error

Change a User Password

Parameters

userId string - Enter the ID of the user whose password you want to change. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

payload ChangeUserPasswordRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ChangeUserPasswordResponse|error - OK

checkFileExists

Isolated FunctionRemote Function

function checkFileExists(string binaryDataId, map<string|string[]> headers) returns CheckFileExistsEnvelope|error

Check a File

Parameters

binaryDataId string - If the typedId is, for example, 1145.BD then the binaryDataId is 1145

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CheckFileExistsEnvelope|error - OK

convertQuoteToDeal

Isolated FunctionRemote Function

function convertQuoteToDeal(string identifier, map<string|string[]> headers) returns QuoteResponse|error

Convert to a Deal

Parameters

identifier string - Can be either the uniqueName or the typedId

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

convertToPriceList

Isolated FunctionRemote Function

function convertToPriceList(string id, map<string|string[]> headers) returns ConvertPriceListResponse|error

Convert to Price List

Parameters

id string - The id to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConvertPriceListResponse|error - OK

copyLogic

Isolated FunctionRemote Function

function copyLogic(string id, map<string|string[]> headers) returns CopyLogicResponse|error

Copy a Logic

Parameters

id string - The ID of the logic. you want to copy. The id is the typedId without the F suffix. For example, the id attribute of the item with typedId = 2147484837.F is 2147484837

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CopyLogicResponse|error - OK

copyLookupTable

Isolated FunctionRemote Function

function copyLookupTable(string tableId, map<string|string[]> headers) returns CopyLookupTableResponse|error

Copy a Lookup Table

Parameters

tableId string - Enter the ID of the table you want to copy

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CopyLookupTableResponse|error - OK

copyManualPriceList

Isolated FunctionRemote Function

function copyManualPriceList(string id, map<string|string[]> headers) returns ManualPriceListResponse|error

Copy a Manual Price List

Parameters

id string - The ID of the Manual Price List you want to copy

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ManualPriceListResponse|error - Example response

copyPriceGrid

Isolated FunctionRemote Function

function copyPriceGrid(string id, map<string|string[]> headers) returns CopyPriceGridResponse|error

Copy a Price Grid

Parameters

id string - The id of the Live Price Grid you want to copy. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CopyPriceGridResponse|error - OK

copyQuote

Isolated FunctionRemote Function

function copyQuote(string typedId, record {} payload, map<string|string[]> headers) returns CopyQuoteEnvelope|error

Copy a Quote

Parameters

typedId string - The typedId to be sent with the request

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CopyQuoteEnvelope|error - OK

copyRoles

Isolated FunctionRemote Function

function copyRoles(CopyRolesRequest payload, map<string|string[]> headers) returns CopyRolesResponse|error

Copy Roles

Parameters

payload CopyRolesRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CopyRolesResponse|error - OK

copyUser

Isolated FunctionRemote Function

function copyUser(string userid, map<string|string[]> headers) returns CopyUserResponse|error

Copy a User

Parameters

userid string - The ID of the user you want to copy. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CopyUserResponse|error - OK

countKeys

Isolated FunctionRemote Function

function countKeys(string tableName, map<string|string[]> headers) returns error?

Count Keys

Parameters

tableName string - The table to count keys from

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK - the number of keys

countMassActionItems

Isolated FunctionRemote Function

function countMassActionItems(string id, CountMassActionItemsRequest payload, map<string|string[]> headers) returns CountMassActionItemsResponse|error

Count Mass Action Items

Parameters

id string - The id to be sent with the request

payload CountMassActionItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CountMassActionItemsResponse|error - OK

createActionItem

Isolated FunctionRemote Function

function createActionItem(AddActionItemRequest payload, map<string|string[]> headers) returns AddActionItemResponse|error

Create an Action Item

Parameters

payload AddActionItemRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddActionItemResponse|error - OK

createClic

Isolated FunctionRemote Function

function createClic("Q"|"QTMP"  typeCode, ClicmanagerCreateTypeCodeBody payload, map<string|string[]> headers) returns ClicOperationEnvelope|error

Create a Quote

Parameters

typeCode "Q"|"QTMP" - Enter the type code of the entity you want to create

payload ClicmanagerCreateTypeCodeBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ClicOperationEnvelope|error - OK

createCustomForm

Isolated FunctionRemote Function

function createCustomForm(CreateCustomFormRequest payload, map<string|string[]> headers) returns CreateCustomFormEnvelope|error

Create a Custom Form

Parameters

payload CreateCustomFormRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CreateCustomFormEnvelope|error - OK

createCustomFormRevision

Isolated FunctionRemote Function

function createCustomFormRevision(string typedId, record {} payload, map<string|string[]> headers) returns CustomFormRevisionEnvelope|error

Create a Custom Form Revision

Parameters

typedId string - typedId of the Custom Form you want to create a revision from

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomFormRevisionEnvelope|error - OK

createCustomFormType

Isolated FunctionRemote Function

function createCustomFormType(CreateCustomFormTypeRequest payload, map<string|string[]> headers) returns CreateCustomFormTypeResponse|error

Create a Custom Form Type

Parameters

payload CreateCustomFormTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CreateCustomFormTypeResponse|error - OK

createDMFieldCollection

Isolated FunctionRemote Function

function createDMFieldCollection("DMDS"|"DMT"  fcType, DatamartCreatefcfcTypeBody payload, map<string|string[]> headers) returns error?

Create a DMFieldCollection

Parameters

fcType "DMDS"|"DMT" - The type of FC (FieldCollection) you want to create

payload DatamartCreatefcfcTypeBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

createDataManagerEntity

Isolated FunctionRemote Function

function createDataManagerEntity("DMF"|"DM"|"DMDS"  typeCode, CreateDataManagerEntityRequest payload, map<string|string[]> headers) returns DmObjectResponse|error

Create a Data Manager Entity

Parameters

typeCode "DMF"|"DM"|"DMDS" - The type code of the Field Collection you want to update

payload CreateDataManagerEntityRequest - Either uniqueName or typedId must be provided in the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DmObjectResponse|error - Example response

createKvTable

Isolated FunctionRemote Function

function createKvTable(string tableName, CreateKVTableRequest payload, map<string|string[]> headers) returns GenericDataResponse|error

Create a KV Table

Parameters

tableName string - A name of the table you want create. Only lower case letters, numbers and underscores are allowed. Do not use special characters

payload CreateKVTableRequest - The sample request creates a table with four columns: sku, customer, record and payload (TEXT).

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

createManualPriceList

Isolated FunctionRemote Function

function createManualPriceList(CreateManualPriceListRequest payload, map<string|string[]> headers) returns ManualPriceListResponse|error

Create a Manual Price List

Parameters

payload CreateManualPriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ManualPriceListResponse|error - Example response

createObject

Isolated FunctionRemote Function

function createObject(string typeCode, CreateObjectRequest_1 payload, map<string|string[]> headers) returns error?

Create an Object

Parameters

typeCode string - The object's type code. See the list of Type Codes

payload CreateObjectRequest_1 - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

createPriceList

Isolated FunctionRemote Function

function createPriceList(CreatePriceListRequest payload, map<string|string[]> headers) returns CreatePriceListResponse|error

Create a Price List

Parameters

payload CreatePriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CreatePriceListResponse|error - OK

createPriceListRevision

Isolated FunctionRemote Function

function createPriceListRevision(string id, CreateRevisionRequest payload, map<string|string[]> headers) returns PriceListItemResponse|error

Create a Revision

Parameters

id string - The ID of the Price List you want to create a revision for. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

payload CreateRevisionRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceListItemResponse|error - Example response

createQuoteRevision

Isolated FunctionRemote Function

function createQuoteRevision(string identifier, map<string|string[]> headers) returns QuoteResponse|error

Create a New Revision

Parameters

identifier string - Can be either the uniqueName or the typedId

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

createUploadSlot

Isolated FunctionRemote Function

function createUploadSlot(map<string|string[]> headers, *CreateUploadSlotQueries queries) returns CreateUploadSlotEnvelope|error

Create an Upload Slot

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateUploadSlotQueries - Queries to be sent with the request

Return Type

CreateUploadSlotEnvelope|error - Slot created

createWorkflowDelegation

Isolated FunctionRemote Function

function createWorkflowDelegation(CreateWorkflowDelegationRequest payload, map<string|string[]> headers) returns CreateWorkflowDelegationResponse|error

Create a Workflow Delegation

Parameters

payload CreateWorkflowDelegationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CreateWorkflowDelegationResponse|error - OK

deactivateWorkflowDelegation

Isolated FunctionRemote Function

function deactivateWorkflowDelegation(DeactivateWorkflowDelegationRequest payload, map<string|string[]> headers) returns DeactivateWorkflowDelegationResponse|error

Deactivate a Workflow Delegation

Parameters

payload DeactivateWorkflowDelegationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeactivateWorkflowDelegationResponse|error - OK

deleteActionItem

Isolated FunctionRemote Function

function deleteActionItem(DeleteActionItemRequest payload, map<string|string[]> headers) returns DeleteActionItemResponse|error

Delete an Action Item

Parameters

payload DeleteActionItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteActionItemResponse|error - OK

deleteActionItemType

Isolated FunctionRemote Function

function deleteActionItemType(record { data record { typedId string } } payload, map<string|string[]> headers) returns DeleteActionItemTypeResponse|error

Delete an Action Item Type

Parameters

payload record { data record { typedId string } } - The general delete request. Deletes the object specified by typedId in the request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteActionItemTypeResponse|error - OK

deleteBusinessRole

Isolated FunctionRemote Function

function deleteBusinessRole(DeleteBusinessRoleRequest payload, map<string|string[]> headers) returns DeleteBusinessRoleResponse|error

Delete a Business Role

Parameters

payload DeleteBusinessRoleRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteBusinessRoleResponse|error - OK

deleteCalculatedFieldSet

Isolated FunctionRemote Function

function deleteCalculatedFieldSet(DeleteCalculatedFieldSetRequest payload, map<string|string[]> headers) returns error?

Delete a Calculated Field Set

Parameters

payload DeleteCalculatedFieldSetRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

deleteCalculation

Isolated FunctionRemote Function

function deleteCalculation(DeleteCalculationRequest payload, map<string|string[]> headers) returns DeleteCalculationResponse|error

Delete a Calculation

Parameters

payload DeleteCalculationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCalculationResponse|error - OK - returns the deleted object's data

deleteCalculationGrid

Isolated FunctionRemote Function

function deleteCalculationGrid(DeleteCalculationGridRequest payload, map<string|string[]> headers) returns DeleteCalculationGridResponse|error

Delete a Calculation Grid

Parameters

payload DeleteCalculationGridRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCalculationGridResponse|error - OK

deleteCalculationGridItem

Isolated FunctionRemote Function

function deleteCalculationGridItem("1"|"2"|"3"|"4"|"5"|"6"  keyNumber, DeleteCalculationGridItemRequest payload, map<string|string[]> headers) returns DeleteCalculationGridItemResponse|error

Delete a Calculation Grid Item

Parameters

keyNumber "1"|"2"|"3"|"4"|"5"|"6" - Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys

payload DeleteCalculationGridItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCalculationGridItemResponse|error - OK

deleteClaimType

Isolated FunctionRemote Function

function deleteClaimType(DeleteClaimTypeRequest payload, map<string|string[]> headers) returns DeleteClaimTypeResponse|error

Delete a Claim Type

Parameters

payload DeleteClaimTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteClaimTypeResponse|error - OK

deleteColumnValues

Isolated FunctionRemote Function

function deleteColumnValues(string typeCode, string columnName, map<string|string[]> headers) returns DeleteColumnValuesResponse|error

Delete Column Values

Parameters

typeCode string - The object's type code. See the list of Type Codes

columnName string - The name of the column/attribute you want to remove values from

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteColumnValuesResponse|error - OK

deleteColumnValuesMatrix

Isolated FunctionRemote Function

function deleteColumnValuesMatrix(string tableId, string columnName, map<string|string[]> headers) returns error?

Delete Column Values (Matrix only)

Parameters

tableId string - Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method

columnName string - Enter the name of the column you want to delete values from

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

deleteComment

Isolated FunctionRemote Function

function deleteComment(string typedId, map<string|string[]> headers) returns DeleteCommentEnvelope|error

Delete a Comment

Parameters

typedId string - Comment or CommentThread typedId

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCommentEnvelope|error - OK

deleteCompensationPlan

Isolated FunctionRemote Function

function deleteCompensationPlan(DeleteCompensationPlanRequest payload, map<string|string[]> headers) returns DeleteCompensationPlanResponse|error

Delete a Compensation Plan

Parameters

payload DeleteCompensationPlanRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCompensationPlanResponse|error - OK. Returns the deleted Compensation Plan object

deleteCompensationType

Isolated FunctionRemote Function

function deleteCompensationType(DeleteCOHTBody payload, map<string|string[]> headers) returns DeleteCompensationTypeEnvelope|error

Delete a Compensation Type

Parameters

payload DeleteCOHTBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCompensationTypeEnvelope|error - OK - returns the deleted object

deleteConditionRecordItemMeta

Isolated FunctionRemote Function

function deleteConditionRecordItemMeta(DeleteCRCIMBody payload, map<string|string[]> headers) returns ConditionRecordItemMetaOperationEnvelope|error

Delete a Condition Record Item Attribute Meta

Parameters

payload DeleteCRCIMBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordItemMetaOperationEnvelope|error - OK

deleteConditionRecordSet

Isolated FunctionRemote Function

function deleteConditionRecordSet(DcrmanagerDeletemassopidBody payload, map<string|string[]> headers) returns ConditionRecordSetOperationEnvelope|error

Delete a Condition Records Set

Parameters

payload DcrmanagerDeletemassopidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordSetOperationEnvelope|error - OK

deleteConditionType

Isolated FunctionRemote Function

function deleteConditionType(DeleteConditionTypeRequest payload, map<string|string[]> headers) returns DeleteConditionTypeEnvelope|error

Delete a Condition Type

Parameters

payload DeleteConditionTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteConditionTypeEnvelope|error - OK

deleteConfigurationStorage

Isolated FunctionRemote Function

function deleteConfigurationStorage(record {} payload, map<string|string[]> headers) returns ConfigurationStorageOperationEnvelope|error

Delete a Configuration Storage

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConfigurationStorageOperationEnvelope|error - OK

deleteCustomForm

Isolated FunctionRemote Function

function deleteCustomForm(DeleteCustomFormRequest payload, map<string|string[]> headers) returns GenericDataResponse|error

Delete a Custom Form

Parameters

payload DeleteCustomFormRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

deleteCustomFormType

Isolated FunctionRemote Function

function deleteCustomFormType(DeleteCFOTBody payload, map<string|string[]> headers) returns DeleteCustomFormTypeEnvelope|error

Delete a Custom Form Type

Parameters

payload DeleteCFOTBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCustomFormTypeEnvelope|error - OK

deleteCustomer

Isolated FunctionRemote Function

function deleteCustomer(DeleteCustomerRequest payload, map<string|string[]> headers) returns DeleteCustomerResponse|error

Delete a Customer

Parameters

payload DeleteCustomerRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCustomerResponse|error - OK

deleteCustomerExtension

Isolated FunctionRemote Function

function deleteCustomerExtension(DeleteCustomerExtensionRequest payload, map<string|string[]> headers) returns DeleteCustomerExtensionResponse|error

Delete a Customer Extension

Parameters

payload DeleteCustomerExtensionRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteCustomerExtensionResponse|error - OK

deleteDataChangeRequestItem

Isolated FunctionRemote Function

function deleteDataChangeRequestItem(string id, DeleteDCRIRequest payload, map<string|string[]> headers) returns DeleteDCRIResponse|error

Delete a Data Change Request Item

Parameters

id string - id of the Data Change Request whose item you want to delete

payload DeleteDCRIRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteDCRIResponse|error - OK

deleteDataChangeRequestMassChange

Isolated FunctionRemote Function

function deleteDataChangeRequestMassChange(string id, DcrmanagerDeletemassopidBody payload, map<string|string[]> headers) returns DataChangeRequestMassChangeEnvelope|error

Delete a Data Change Request Mass Change

Parameters

id string - id of the Data Change Request

payload DcrmanagerDeletemassopidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DataChangeRequestMassChangeEnvelope|error - OK

deleteDataManagerEntity

Isolated FunctionRemote Function

function deleteDataManagerEntity("DM"|"DMF"|"DMDS"  typeCode, DeleteDataManagerEntityRequest payload, map<string|string[]> headers) returns DeleteDataManagerEntityResponse|error

Delete a Data Manager Entity

Parameters

typeCode "DM"|"DMF"|"DMDS" - The type code of the Field Collection you want to delete

payload DeleteDataManagerEntityRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteDataManagerEntityResponse|error - OK

deleteDatamartOrphanObjects

Isolated FunctionRemote Function

function deleteDatamartOrphanObjects(map<string|string[]> headers) returns DatamartOrphanObjectsEnvelope|error

Delete Datamart Orphan Objects

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DatamartOrphanObjectsEnvelope|error - OK

deleteFile

Isolated FunctionRemote Function

function deleteFile(string typedId, string binaryDataId, record {} payload, map<string|string[]> headers) returns GenericDataResponse|error

Delete a File

Parameters

typedId string - typedId of the document whose attachment you want to delete

binaryDataId string - If the typedId is, for example, 1145.BD then the binaryDataId is 1145

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

deleteImportChanges

Isolated FunctionRemote Function

function deleteImportChanges(ImportmanagerDeletechangesBody payload, map<string|string[]> headers) returns GenericDataResponse|error

Delete Import Changes

Parameters

payload ImportmanagerDeletechangesBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

deleteInternationalizationMessages

Isolated FunctionRemote Function

function deleteInternationalizationMessages(I18nmanagerDeleteKeysBody payload, map<string|string[]> headers) returns Response|error

Delete Internationalization Messages

Parameters

payload I18nmanagerDeleteKeysBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - OK - the internationalization keys have been deleted successfully

deleteKey

Isolated FunctionRemote Function

function deleteKey(string tableName, DeleteKVKeyRequest payload, map<string|string[]> headers) returns error?

Delete a Key

Parameters

tableName string - The tableName to be sent with the request

payload DeleteKVKeyRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK. Returns null when successfully deleted

deleteLivePriceGrid

Isolated FunctionRemote Function

function deleteLivePriceGrid(DeleteLivePriceGridRequest payload, map<string|string[]> headers) returns DeleteLivePriceGridResponse|error

Delete a Live Price Grid

Parameters

payload DeleteLivePriceGridRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteLivePriceGridResponse|error - OK

deleteLivePriceGridType

Isolated FunctionRemote Function

function deleteLivePriceGridType(DeletePLTTBody payload, map<string|string[]> headers) returns LivePriceGridTypeOperationEnvelope|error

Delete a Live Price Grid Type

Parameters

payload DeletePLTTBody -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LivePriceGridTypeOperationEnvelope|error - OK

deleteLogic

Isolated FunctionRemote Function

function deleteLogic(string id, map<string|string[]> headers) returns DeleteLogicResponse|error

Delete a Logic

Parameters

id string - The ID of the logic you want to delete. id is the typedId without F suffix. For example, the id attribute of the item with typedId = 2147484835.F is 2147484835

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteLogicResponse|error - OK

deleteLookupTable

Isolated FunctionRemote Function

function deleteLookupTable(DeleteLookupTableRequest payload, map<string|string[]> headers) returns DeleteLookupTableResponse|error

Delete a Lookup Table

Parameters

payload DeleteLookupTableRequest - Specify the typedId of the Lookup Table (Company Parameters) you want to delete

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteLookupTableResponse|error - OK

deleteLookupTableValue

Isolated FunctionRemote Function

function deleteLookupTableValue(string tableId, DeleteLookupTableValueRequest payload, map<string|string[]> headers) returns DeleteLookupTableValueResponse|error

Delete a Lookup Table Value

Parameters

tableId string - Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method

payload DeleteLookupTableValueRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteLookupTableValueResponse|error - OK

deleteManualPriceList

Isolated FunctionRemote Function

function deleteManualPriceList(DeleteManualPriceListRequest payload, map<string|string[]> headers) returns ManualPriceListResponse|error

Delete a Manual Price List

Parameters

payload DeleteManualPriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ManualPriceListResponse|error - Example response

deleteManualPriceListProduct

Isolated FunctionRemote Function

function deleteManualPriceListProduct(string id, DeleteProductFromManualPriceListRequest payload, map<string|string[]> headers) returns ProductResponse|error

Delete a Product from a Manual Price List

Parameters

id string - The ID of the Manual Price List whose product you want to delete

payload DeleteProductFromManualPriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

deleteManualPriceListProducts

Isolated FunctionRemote Function

function deleteManualPriceListProducts(string id, DeleteProductsFromManualPriceListRequest payload, map<string|string[]> headers) returns DeleteProductsFromManualPriceListResponse|error

Delete Products from a Manual Price List

Parameters

id string - The ID of the Manual Price List whose products you want to delete

payload DeleteProductsFromManualPriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteProductsFromManualPriceListResponse|error - OK

deleteNotification

Isolated FunctionRemote Function

function deleteNotification(NotificationSetreadBody payload, map<string|string[]> headers) returns DeleteNotificationEnvelope|error

Delete a Notification

Parameters

payload NotificationSetreadBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteNotificationEnvelope|error - OK

deleteObject

Isolated FunctionRemote Function

function deleteObject("ACTT"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CLLI"|"CN"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DREG"|"DWT"|"ET"|"EVT"|"F"|"FE"|"FN"|"IDC"|"IE"|"ISH"|"JST"|"JLTV"|"JLTVM"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"P"|"PAM"|"PAPIJ"|"PBOME"|"PCOMP"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI"  typeCode, DeleteObjectRequest_1 payload, map<string|string[]> headers) returns DeleteObjectResponse_1|error

Delete an Object

Parameters

typeCode "ACTT"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CLLI"|"CN"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DREG"|"DWT"|"ET"|"EVT"|"F"|"FE"|"FN"|"IDC"|"IE"|"ISH"|"JST"|"JLTV"|"JLTVM"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"P"|"PAM"|"PAPIJ"|"PBOME"|"PCOMP"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" - Enter the type code of the entity you want to delete the object from. See the list of Type Codes in the Pricefx Knowledge Base article

payload DeleteObjectRequest_1 - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteObjectResponse_1|error - OK

deleteObjects

Isolated FunctionRemote Function

function deleteObjects(string typeCode, DeleteObjectsForceFilterRequest payload, map<string|string[]> headers) returns DeleteObjectsResponse|error

Delete Objects

Parameters

typeCode string - The object's type code. See the list of Type Codes

payload DeleteObjectsForceFilterRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteObjectsResponse|error - OK

deletePriceGridItem

Isolated FunctionRemote Function

function deletePriceGridItem(string id, DeletePriceGridItemRequest payload, map<string|string[]> headers) returns PriceGridItemResponse|error

Delete a Price Grid Item

Parameters

id string - The ID of the Price Grid you want to delete the Price Grid Item from

payload DeletePriceGridItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceGridItemResponse|error - Example response

deletePriceGridItemFilter

Isolated FunctionRemote Function

function deletePriceGridItemFilter(string id, DeletePriceGridItemFilterRequest payload, map<string|string[]> headers) returns error?

Delete a Price Grid Item (Filter)

Parameters

id string - The ID of the Price Grid that contains Price Grid Items you want to delete

payload DeletePriceGridItemFilterRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

deletePriceList

Isolated FunctionRemote Function

function deletePriceList(DeletePriceListRequest payload, map<string|string[]> headers) returns DeletePriceListResponse|error

Delete a Price List

Parameters

payload DeletePriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeletePriceListResponse|error - OK

deletePriceListItems

Isolated FunctionRemote Function

function deletePriceListItems(string id, DeletePriceListItemRequest payload, map<string|string[]> headers) returns DeletePriceListItemResponse|error

Delete a Price List Item

Parameters

id string - Enter the ID of the Price List where you want to delete an item from

payload DeletePriceListItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeletePriceListItemResponse|error - OK - Returns a number of deleted items

deletePriceListType

Isolated FunctionRemote Function

function deletePriceListType(DeletePLTTBody payload, map<string|string[]> headers) returns PriceListTypeOperationEnvelope|error

Delete a Price List Type

Parameters

payload DeletePLTTBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceListTypeOperationEnvelope|error - OK

deleteProduct

Isolated FunctionRemote Function

function deleteProduct(DeleteProductRequest payload, map<string|string[]> headers) returns DeleteProductResponse|error

Delete a Product

Parameters

payload DeleteProductRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteProductResponse|error - OK

deleteProductExtension

Isolated FunctionRemote Function

function deleteProductExtension(DeleteProductExtensionRequest payload, map<string|string[]> headers) returns DeleteProductExtensionResponse|error

Delete a Product Extension

Parameters

payload DeleteProductExtensionRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteProductExtensionResponse|error - OK

deleteRebateAgreement

Isolated FunctionRemote Function

function deleteRebateAgreement(DeleteRebateAgreementRequest payload, map<string|string[]> headers) returns RebateAgreementResponse|error

Delete a Rebate Agreement

Parameters

payload DeleteRebateAgreementRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RebateAgreementResponse|error - Example response

deleteRebateCalculation

Isolated FunctionRemote Function

function deleteRebateCalculation(DeleteRebateCalculationRequest payload, map<string|string[]> headers) returns DeleteRebateCalculationResponse|error

Delete a Rebate Calculation

Parameters

payload DeleteRebateCalculationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteRebateCalculationResponse|error - OK

deleteSeller

Isolated FunctionRemote Function

function deleteSeller(DeleteSellerRequest payload, map<string|string[]> headers) returns DeleteSellerEnvelope|error

Delete a Seller

Parameters

payload DeleteSellerRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteSellerEnvelope|error - OK

deleteSellerExtension

Isolated FunctionRemote Function

function deleteSellerExtension(DeleteSellerExtensionRequest payload, map<string|string[]> headers) returns DeleteSellerExtensionResponse|error

Delete a Seller Extension

Parameters

payload DeleteSellerExtensionRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteSellerExtensionResponse|error - OK

deleteUploadSlot

Isolated FunctionRemote Function

function deleteUploadSlot(string slotId, map<string|string[]> headers) returns UploadSlotOperationEnvelope|error

Delete an Upload Slot

Parameters

slotId string - Enter the ID of the slot you want to delete

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UploadSlotOperationEnvelope|error - Slot deleted

deleteUploadSlotViaGet

Isolated FunctionRemote Function

function deleteUploadSlotViaGet(string slotId, map<string|string[]> headers) returns DeleteUploadSlotResponse|error

Delete an Upload Slot

Parameters

slotId string - Enter the ID of the slot you want to delete

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteUploadSlotResponse|error - Slot deleted

deleteUser

Isolated FunctionRemote Function

function deleteUser(DeleteUserRequest payload, map<string|string[]> headers) returns UserResponse|error

Delete a User

Parameters

payload DeleteUserRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UserResponse|error - Example response

deleteUserGroup

Isolated FunctionRemote Function

function deleteUserGroup(DeleteUserGroupRequest payload, map<string|string[]> headers) returns DeleteUserGroupResponse|error

Delete a User Group

Parameters

payload DeleteUserGroupRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteUserGroupResponse|error - OK

deleteWorkflowDelegation

Isolated FunctionRemote Function

function deleteWorkflowDelegation(DeleteWorkflowDelegationRequest payload, map<string|string[]> headers) returns DeleteWorkflowDelegationResponse|error

Delete a Workflow Delegation

Parameters

payload DeleteWorkflowDelegationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteWorkflowDelegationResponse|error - OK

denyDocument

Isolated FunctionRemote Function

function denyDocument(string currentStepId, DenyDocumentRequest payload, map<string|string[]> headers) returns DenyDocumentResponse|error

Deny a Document

Parameters

currentStepId string - The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint

payload DenyDocumentRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DenyDocumentResponse|error - OK

denyLivePriceGridItem

Isolated FunctionRemote Function

function denyLivePriceGridItem(string id, DenyLivePriceGridItemRequest payload, map<string|string[]> headers) returns PriceGridItemResponse|error

Deny a Live Price Grid Item

Parameters

id string - The ID of the Price Grid that contains the Price Grid Item you want to deny

payload DenyLivePriceGridItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceGridItemResponse|error - Example response

deployConfigurationStorage

Isolated FunctionRemote Function

function deployConfigurationStorage(JcsmanagerDeployBody payload, map<string|string[]> headers) returns ConfigurationStorageOperationEnvelope|error

Deploy a Configuration Storage

Parameters

payload JcsmanagerDeployBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConfigurationStorageOperationEnvelope|error - OK

downloadAttachmentData

Isolated FunctionRemote Function

function downloadAttachmentData(string binaryDataId, map<string|string[]> headers, *DownloadAttachmentDataQueries queries) returns byte[]|error

Download an Attachment

Parameters

binaryDataId string - If the typedId is, for example, 1146.BD then the binaryDataId is 1146

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DownloadAttachmentDataQueries - Queries to be sent with the request

Return Type

byte[]|error - OK - binary data

downloadFile

Isolated FunctionRemote Function

function downloadFile(string typedId, string binaryDataId, map<string|string[]> headers, *DownloadFileQueries queries) returns FileDownloadEnvelope|error

Download a File

Parameters

typedId string - typedId of the document you want to download the attachment from

binaryDataId string - If the typedId is, for example, 1145.BD then the binaryDataId is 1145

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DownloadFileQueries - Queries to be sent with the request

Return Type

FileDownloadEnvelope|error - File metadata or content

downloadFileViaPost

Isolated FunctionRemote Function

function downloadFileViaPost(string typedId, string binaryDataId, map<string|string[]> headers, *DownloadFileViaPostQueries queries) returns Response|error

Download a File

Parameters

typedId string - typedId of the document you want to download the attachment from

binaryDataId string - If the typedId is, for example, 1145.BD then the binaryDataId is 1145

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DownloadFileViaPostQueries - Queries to be sent with the request

Return Type

Response|error - OK

downloadLivePriceGridExcelFile

Isolated FunctionRemote Function

function downloadLivePriceGridExcelFile(string id1, string id2, string id3, string id4, string id5, string id6, string id7, string id8, string id9, string id10, string id11, string id12, string id13, map<string|string[]> headers, *DownloadLivePriceGridExcelFileQueries queries) returns Response|error

Download a Live Price Grid Excel File

Parameters

id1 string - The id1 to be sent with the request

id2 string - The id2 to be sent with the request

id3 string - The id3 to be sent with the request

id4 string - The id4 to be sent with the request

id5 string - The id5 to be sent with the request

id6 string - The id6 to be sent with the request

id7 string - The id7 to be sent with the request

id8 string - The id8 to be sent with the request

id9 string - The id9 to be sent with the request

id10 string - The id10 to be sent with the request

id11 string - The id11 to be sent with the request

id12 string - The id12 to be sent with the request

id13 string - IDs of the Price Grids you want to download

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DownloadLivePriceGridExcelFileQueries - Queries to be sent with the request

Return Type

Response|error - OK

dropKvTable

Isolated FunctionRemote Function

function dropKvTable(string tableName, record {} payload, map<string|string[]> headers) returns record {}|error

Drop a KV Table

Parameters

tableName string - A name of the table you want drop. Only lower case letters, numbers and underscores are allowed. Do not use special characters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

record {}|error - Table dropped

duplicateCompensationPlan

Isolated FunctionRemote Function

function duplicateCompensationPlan(string typedId, map<string|string[]> headers) returns DuplicateCompensationPlanEnvelope|error

Duplicate a Compensation Plan

Parameters

typedId string - The typedId of the Compensation Plan you want to duplicate

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DuplicateCompensationPlanEnvelope|error - OK. Returns the duplicated object

duplicateCustomForm

Isolated FunctionRemote Function

function duplicateCustomForm(string typedId, record {} payload, map<string|string[]> headers) returns CustomFormRevisionEnvelope|error

Duplicate a Custom Form

Parameters

typedId string - typedId of the Custom Form you want to duplicate

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomFormRevisionEnvelope|error - OK

duplicateModel

Isolated FunctionRemote Function

function duplicateModel(string typedId, OptimizationModelduplicatetypedIdBody payload, map<string|string[]> headers) returns ModelDuplicationEnvelope|error

Duplicate a Model

Parameters

typedId string - The typedId to be sent with the request

payload OptimizationModelduplicatetypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ModelDuplicationEnvelope|error - OK

editAttachment

Isolated FunctionRemote Function

function editAttachment(string ownerTypedId, string binaryDataId, string slotId, BinaryDataIdslotIdBody payload, map<string|string[]> headers) returns FileDownloadEnvelope|error

Upload a File

Parameters

ownerTypedId string - The TypedId of the document owning the attachment

binaryDataId string - The binaryDataId of the attachment to replace

slotId string - The upload slot_id containing the new file

payload BinaryDataIdslotIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

FileDownloadEnvelope|error - Attachment replaced

editComment

Isolated FunctionRemote Function

function editComment(string typedId, CommentmanagerEdittypedIdBody payload, map<string|string[]> headers) returns CommentOperationEnvelope|error

Edit a Comment

Parameters

typedId string - typedId of the comment you want to edit

payload CommentmanagerEdittypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CommentOperationEnvelope|error - OK

executeDataLoadLogic

Isolated FunctionRemote Function

function executeDataLoadLogic(string typedId, string logicName, map<string|string[]> headers) returns ExecuteDataLoadLogicResponse|error

Execute a Data Load Logic

Parameters

typedId string - The typedId of the Data Load you want to evaluate

logicName string - The name of the logic you want to execute

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecuteDataLoadLogicResponse|error - OK

executeLibraryFunction

Isolated FunctionRemote Function

function executeLibraryFunction(string formulaName, string elementName, string functionName, ElementNamefunctionNameBody payload, map<string|string[]> headers) returns Response|error

Execute Library Function

Parameters

formulaName string - Name of the formula library containing the function

elementName string - Name of the library element containing the function

functionName string - Name of the function to execute

payload ElementNamefunctionNameBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - OK

executeLogic

Isolated FunctionRemote Function

function executeLogic(string typeCode, record {} payload, map<string|string[]> headers) returns ExecuteActionItemLogicResponse|error

Execute a Logic

Parameters

typeCode string - The typeCode of the Action Item you want to execute the calculation for

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecuteActionItemLogicResponse|error - OK

executeLogicInService

Isolated FunctionRemote Function

function executeLogicInService(string uniqueName, record { data record {} } payload, map<string|string[]> headers) returns LogicResponse|error

Execute a Logic Without a Context in a Service

Parameters

uniqueName string - The name (uniqueName) of the logic you want to execute

payload record { data record {} } -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LogicResponse|error - Example response

executeLogicInServiceReadOnly

Isolated FunctionRemote Function

function executeLogicInServiceReadOnly(string uniqueName, map<string|string[]> headers) returns ExecuteLogicReadOnlyResponse|error

Execute a Logic Without a Context in a Service (Read-Only)

Parameters

uniqueName string - The name (uniqueName) of the logic you want to execute

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecuteLogicReadOnlyResponse|error - OK

executeLogicRead

Isolated FunctionRemote Function

function executeLogicRead(string uniqueName, map<string|string[]> headers) returns ExecuteLogicReadOnlyResponse|error

Execute a Logic (Read-Only)

Parameters

uniqueName string - The name (uniqueName) of the logic you want to execute

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecuteLogicReadOnlyResponse|error - OK

executeLogicWithout

Isolated FunctionRemote Function

function executeLogicWithout(string uniqueName, record { data record {} } payload, map<string|string[]> headers, *ExecuteLogicWithoutQueries queries) returns ExecuteLogicWithoutProductContextResponse|error

Execute a Logic (Without a Context)

Parameters

uniqueName string - The name (uniqueName) of the logic you want to execute

payload record { data record {} } -

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ExecuteLogicWithoutQueries - Queries to be sent with the request

Return Type

ExecuteLogicWithoutProductContextResponse|error - OK

executeModelLogic

Isolated FunctionRemote Function

function executeModelLogic(string typedId, string stepName, string formulaName, ExecuteModelLogicRequest payload, map<string|string[]> headers) returns ExecuteModelLogicResponse|error

Execute a Model Logic

Parameters

typedId string - The typedId of the Model Object you want to execute the logic for

stepName string - The name of the step you want to execute the logic for

formulaName string - The name of the logic you want to execute

payload ExecuteModelLogicRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecuteModelLogicResponse|error - OK

executeNamedProductLogic

Isolated FunctionRemote Function

function executeNamedProductLogic(string sku, string uniqueName, record { data record {} } payload, map<string|string[]> headers) returns ExecuteLogicResponse|error

Execute a Logic

Parameters

sku string - The sku or typedId of the product you want to execute the assigned logic for

uniqueName string - The name (uniqueName) of the logic you want to execute

payload record { data record {} } -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecuteLogicResponse|error - OK

executeProductLogic

Isolated FunctionRemote Function

function executeProductLogic(string sku, record { data record {} } payload, map<string|string[]> headers) returns ExecuteAssignedLogicResponse|error

Execute an Assigned Logic

Parameters

sku string - The sku or typedId of the product you want to execute the logic for

payload record { data record {} } -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecuteAssignedLogicResponse|error - OK

exportContractPdf

Isolated FunctionRemote Function

function exportContractPdf(string uniqueName, map<string|string[]> headers) returns Response|error

Export a PDF File

Parameters

uniqueName string - Specify the uniqueName of the A&P you want to download

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - OK - returns the file data

exportCsvFile

Isolated FunctionRemote Function

function exportCsvFile(ExportCSVFileRequest payload, map<string|string[]> headers, *ExportCsvFileQueries queries) returns error?

Export a CSV File

Parameters

payload ExportCSVFileRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ExportCsvFileQueries - Queries to be sent with the request

Return Type

error? - OK - returns the ZIP file (binary data): Content-Type: application/zip

exportDatamart

Isolated FunctionRemote Function

function exportDatamart(string fcTypedIdOrSourceName, ExportDatamartRequest payload, map<string|string[]> headers, *ExportDatamartQueries queries) returns ExportDatamartResponse|error

Export Datamart

Parameters

fcTypedIdOrSourceName string - Restricts the export to a specific source, identified by either the 'typedId' or 'sourceName'.

payload ExportDatamartRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ExportDatamartQueries - Queries to be sent with the request

Return Type

ExportDatamartResponse|error - OK

exportExcelFileXlsx

Isolated FunctionRemote Function

function exportExcelFileXlsx(ExportExcelFileRequest payload, map<string|string[]> headers, *ExportExcelFileXlsxQueries queries) returns error?

Export an Excel File (XLSX)

Parameters

payload ExportExcelFileRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ExportExcelFileXlsxQueries - Queries to be sent with the request

Return Type

error? - OK - returns the XLSX file (binary data): Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

exportModels

Isolated FunctionRemote Function

function exportModels(OptimizationModelexportBody payload, map<string|string[]> headers) returns Response|error

Export Models

Parameters

payload OptimizationModelexportBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - OK - A ZIP file containing the exported model JSON files

exportQuoteDocx

Isolated FunctionRemote Function

function exportQuoteDocx(string uniqueName, map<string|string[]> headers, *ExportQuoteDocxQueries queries) returns error?

Export a DOCX File

Parameters

uniqueName string - Specify the uniqueName of the quote you want to download

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ExportQuoteDocxQueries - Queries to be sent with the request

Return Type

error? - OK

exportQuoteExcel

Isolated FunctionRemote Function

function exportQuoteExcel(string uniqueName, map<string|string[]> headers, *ExportQuoteExcelQueries queries) returns error?

Export an Excel File

Parameters

uniqueName string - Specify the uniqueName of the quote you want to download

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ExportQuoteExcelQueries - Queries to be sent with the request

Return Type

error? - OK - returns a file data

exportQuotePdf

Isolated FunctionRemote Function

function exportQuotePdf(string uniqueName, map<string|string[]> headers, *ExportQuotePdfQueries queries) returns record {}|error

Export a PDF File

Parameters

uniqueName string - Specify the uniqueName of the quote you want to download

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ExportQuotePdfQueries - Queries to be sent with the request

Return Type

record {}|error - OK - returns the file data

fetchActivities

Isolated FunctionRemote Function

function fetchActivities(ActivitylogFetchBody payload, map<string|string[]> headers) returns record {}|FetchActivitiesEnvelope|error

Fetch Activities

Parameters

payload ActivitylogFetchBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

record {}|FetchActivitiesEnvelope|error - OK

fetchDataMartObject

Isolated FunctionRemote Function

function fetchDataMartObject(string objectId, GetDMObjectRequest payload, map<string|string[]> headers, *FetchDataMartObjectQueries queries) returns GetDMObjectResponse|error

Get a DM Object

Parameters

objectId string - Use one of the following object identifiers:
- typedUniquename – Format: "<typeCode>.<uniqueName>" (e.g., DMDS.SalesTransactions)
- typedId – Format: "<dbId>.<typeCode>" (e.g., 123456.DMDS)'
- "*" (asterisk) – Asterisk can be used when you are providing a source$query in data within the request body

payload GetDMObjectRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *FetchDataMartObjectQueries - Queries to be sent with the request

Return Type

GetDMObjectResponse|error - OK

fetchPendingReviews

Isolated FunctionRemote Function

function fetchPendingReviews(map<string|string[]> headers) returns FetchPendingReviewsEnvelope|error

Fetch Pending Reviews

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

FetchPendingReviewsEnvelope|error - OK

generateJwtToken

Isolated FunctionRemote Function

function generateJwtToken(GenerateJWTTokenRequest payload, map<string|string[]> headers) returns GenerateJWTTokenResponse|error

Generate a JWT Token

Parameters

payload GenerateJWTTokenRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenerateJWTTokenResponse|error - OK

generateParameters

Isolated FunctionRemote Function

function generateParameters(GenerateParametersRequest payload, map<string|string[]> headers) returns GenerateParametersResponse|error

Generate Parameters

Parameters

payload GenerateParametersRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenerateParametersResponse|error - OK

generateTimedJwtToken

Isolated FunctionRemote Function

function generateTimedJwtToken(string minutes, map<string|string[]> headers) returns GenerateJWTTokenTimeLimitedResponse|error

Generate a JWT Token (time limited)

Parameters

minutes string - The number of minutes in which the token expires

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenerateJWTTokenTimeLimitedResponse|error - OK

getActionStatus

Isolated FunctionRemote Function

function getActionStatus(string actionUUID, map<string|string[]> headers) returns GetActionStatusResponse|error

Get Action Status

Parameters

actionUUID string - The actionUUID to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetActionStatusResponse|error - OK

getAdvancedConfigurationProperty

Isolated FunctionRemote Function

function getAdvancedConfigurationProperty(string propertyname, map<string|string[]> headers) returns AdvancedConfigPropertyEnvelope|error

Get Advanced Configuration Property

Parameters

propertyname string - Name of the configuration property to retrieve

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AdvancedConfigPropertyEnvelope|error - Property found

getCalculationGrid

Isolated FunctionRemote Function

function getCalculationGrid(string id, record {} payload, map<string|string[]> headers) returns GetCalculationGridResponse|error

Get a Calculation Grid

Parameters

id string - ID of the Calculation Grid you want to retrieve

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetCalculationGridResponse|error - OK

getCalculationGridItem

Isolated FunctionRemote Function

function getCalculationGridItem("1"|"2"|"3"|"4"|"5"|"6"  keyNumber, string id, record {} payload, map<string|string[]> headers) returns GetCalculationGridItemResponse|error

Get a Calculation Grid Item

Parameters

keyNumber "1"|"2"|"3"|"4"|"5"|"6" - Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys

id string - id of the Calculation Grid Item you want to fetch

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetCalculationGridItemResponse|error - OK

getCalculationStatus

Isolated FunctionRemote Function

function getCalculationStatus(string typedId, map<string|string[]> headers) returns JobStatusTrackerResponse|error

Get a Calculation Status

Parameters

typedId string - The typedId of the Model Object you want to retrieve the calculation status for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobStatusTrackerResponse|error - Example response

getClicDraftHeader

Isolated FunctionRemote Function

function getClicDraftHeader(string typedId, record {} payload, map<string|string[]> headers) returns ClicDraftHeaderEnvelope|error

Get a Temporary Data

Parameters

typedId string - typedId of the Quote you want to retrieve the temporary data from

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ClicDraftHeaderEnvelope|error - OK

getClicFolderStats

Isolated FunctionRemote Function

function getClicFolderStats(string typedId, map<string|string[]> headers, *GetClicFolderStatsQueries queries) returns ClicFolderStatsEnvelope|error

Get Folder Statistics

Parameters

typedId string - typedId of the document whose folder statistics you want to fetch

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetClicFolderStatsQueries - Queries to be sent with the request

Return Type

ClicFolderStatsEnvelope|error - OK

getClicHeader

Isolated FunctionRemote Function

function getClicHeader(string typedId, map<string|string[]> headers) returns GetQuoteContractRebateAgreementResponse|error

Get a Quote/Contract/Rebate Agreement/Compensation Plan Header

Parameters

typedId string - The typedId of the Contract, Quote, or Rebate Agreement you want to return details for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetQuoteContractRebateAgreementResponse|error - OK

getConditionRecordItem

Isolated FunctionRemote Function

function getConditionRecordItem(record {} payload, map<string|string[]> headers) returns ConditionRecordItemEnvelope|error

Get a Condition Record Item

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordItemEnvelope|error - OK

getConditionRecordItemMeta

Isolated FunctionRemote Function

function getConditionRecordItemMeta(FetchCRCIMBody payload, map<string|string[]> headers) returns ConditionRecordItemMetaEnvelope|error

Get a Condition Record Item Attribute Meta

Parameters

payload FetchCRCIMBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordItemMetaEnvelope|error - OK

getConditionRecordSetItems

Isolated FunctionRemote Function

function getConditionRecordSetItems(ConditionrecordsetFetchCRCI3Body payload, map<string|string[]> headers) returns ConditionRecordSetItemsEnvelope|error

Get Condition Record Set Items With Set Id Validation

Parameters

payload ConditionrecordsetFetchCRCI3Body - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordSetItemsEnvelope|error - OK

getConfigurationStorage

Isolated FunctionRemote Function

function getConfigurationStorage(FetchJCSBody payload, map<string|string[]> headers) returns GetConfigurationStorageEnvelope|error

Get a Configuration Storage

Parameters

payload FetchJCSBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetConfigurationStorageEnvelope|error - OK

getContract

Isolated FunctionRemote Function

function getContract(string uniqueName, map<string|string[]> headers) returns ContractModelResponse|error

Get a Contract

Parameters

uniqueName string - uniqueName of the Contract you want to retrieve details for. Alternatively, typedId can be also used

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ContractModelResponse|error - Example response

getCustomForm

Isolated FunctionRemote Function

function getCustomForm(string typedId, map<string|string[]> headers) returns GetCustomFormResponse|error

Get a Custom Form

Parameters

typedId string - The typedId of the Custom Form you want to retrieve details for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetCustomFormResponse|error - OK

getCustomer

Isolated FunctionRemote Function

function getCustomer(string id, map<string|string[]> headers) returns CustomerResponse|error

Get a Customer

Parameters

id string - The ID of the Customer you want to retrieve details for. The id is the typedId without the C suffix. For example, the id parameter of the item with typedId = 2147492200.C is 2147492200

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomerResponse|error - Returns customer record details

getDataChangeRequest

Isolated FunctionRemote Function

function getDataChangeRequest(string id, GetDCRRequest payload, map<string|string[]> headers) returns GetDCRResponse|error

Get a Data Change Request

Parameters

id string - id of the Data Change Request you want to retrieve

payload GetDCRRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetDCRResponse|error - OK

getDataChangeRequestChanges

Isolated FunctionRemote Function

function getDataChangeRequestChanges(string id, GetDCRRequestChangeOnly payload, map<string|string[]> headers) returns GetDCRResponseChangeOnly|error

Get a Data Change Request (changes only)

Parameters

id string - id of the Data Change Request you want to retrieve changed items for

payload GetDCRRequestChangeOnly - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetDCRResponseChangeOnly|error - OK

getDataChangeRequestMassChanges

Isolated FunctionRemote Function

function getDataChangeRequestMassChanges(string id, DcrmanagerFetchmassopidBody payload, map<string|string[]> headers) returns DataChangeRequestMassChangeEnvelope|error

Get Data Change Request Mass Changes

Parameters

id string - id of the Data Change Request

payload DcrmanagerFetchmassopidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DataChangeRequestMassChangeEnvelope|error - OK

getDataMartObject

Isolated FunctionRemote Function

function getDataMartObject(string objectId, map<string|string[]> headers, *GetDataMartObjectQueries queries) returns DataMartObjectEnvelope|error

Get a DM Object

Parameters

objectId string - Use one of the following object identifiers:
- typedUniquename – Format: "<typeCode>.<uniqueName>" (e.g., DMDS.SalesTransactions)
- typedId – Format: "<dbId>.<typeCode>" (e.g., 123456.DMDS)'
- "*" (asterisk) – Asterisk can be used when you are providing a source$query in data within the request body

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDataMartObjectQueries - Queries to be sent with the request

Return Type

DataMartObjectEnvelope|error - Exported data

getDefaultPricingLogicName

Isolated FunctionRemote Function

function getDefaultPricingLogicName(map<string|string[]> headers) returns GetDefaultPricingLogicNameResponse|error

Get a Default Pricing Logic Name

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetDefaultPricingLogicNameResponse|error - OK

getDmExportFile

Isolated FunctionRemote Function

function getDmExportFile(string fileName, map<string|string[]> headers) returns error?

Get a DM Export File

Parameters

fileName string - The name of the file previously created by a datamart.export request. The filename needs to be an exact match - no wildcards allowed, hence only one file at the time can be fetched

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

getDmObjectNo

Isolated FunctionRemote Function

function getDmObjectNo(string objectId, GetDMObjectNoCountRequest payload, map<string|string[]> headers) returns GetDMObjectNoCountResponse|error

Get a DM Object (no count)

Parameters

objectId string - Use one of the following object identifiers:
- typedUniquename – Format: "<typeCode>.<uniqueName>" (e.g., DMDS.SalesTransactions)
- typedId – Format: "<dbId>.<typeCode>" (e.g., 123456.DMDS)
- "*" (asterisk) – Asterisk can be used when you are providing a source$query in data within the request body

payload GetDMObjectNoCountRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetDMObjectNoCountResponse|error - OK

getExternalApplicationProperties

Isolated FunctionRemote Function

function getExternalApplicationProperties(map<string|string[]> headers) returns GetexternalapppropertiesResponse|error

Get External Application Properties

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetexternalapppropertiesResponse|error - OK

getKey

Isolated FunctionRemote Function

function getKey(string tableName, GetKVKeyRequest payload, map<string|string[]> headers) returns error?

Get a Key

Parameters

tableName string - A name of the table you want to retrieve the "payload" from

payload GetKVKeyRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK. The "payload" is returned

getLivePriceGrid

Isolated FunctionRemote Function

function getLivePriceGrid(string id, map<string|string[]> headers) returns GetLivePriceGridResponse|error

Get a Live Price Grid

Parameters

id string - The id of the Live Price Grid you want to retrieve details for. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetLivePriceGridResponse|error - OK

getLogic

Isolated FunctionRemote Function

function getLogic(string id, map<string|string[]> headers) returns GetLogicResponse|error

Get a Logic

Parameters

id string - The ID of the logic you want to retrieve details for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetLogicResponse|error - OK

getLogicReferences

Isolated FunctionRemote Function

function getLogicReferences(string tableId, map<string|string[]> headers) returns GetLogicReferencesResponse|error

Get Logic References

Parameters

tableId string - Enter the ID of the table you want to retrieve logic references for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetLogicReferencesResponse|error - OK

getLokiLog

Isolated FunctionRemote Function

function getLokiLog(map<string|string[]> headers, *GetLokiLogQueries queries) returns LokiLogEnvelope|error

Get a Loki Log

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetLokiLogQueries - Queries to be sent with the request

Return Type

LokiLogEnvelope|error - OK

getMcpRoles

Isolated FunctionRemote Function

function getMcpRoles(map<string|string[]> headers) returns McpRolesEnvelope|error

Get MCP Roles

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

McpRolesEnvelope|error - Roles received

getMcpTools

Isolated FunctionRemote Function

function getMcpTools(map<string|string[]> headers) returns McpToolsEnvelope|error

Get MCP Tools

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

McpToolsEnvelope|error - Roles received

getNewUploadSlot

Isolated FunctionRemote Function

function getNewUploadSlot(map<string|string[]> headers) returns CreateUploadSlotResponse|error

Create an Upload Slot

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CreateUploadSlotResponse|error - Slot created

getObject

Isolated FunctionRemote Function

function getObject(string typeCode, string id, map<string|string[]> headers) returns GetObjectResponse_1|error

Get an Object

Parameters

typeCode string - The object's type code. See the list of Type Codes

id string - The ID of the object you want to retrieve details for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetObjectResponse_1|error - OK

getOneTimeToken

Isolated FunctionRemote Function

function getOneTimeToken(map<string|string[]> headers) returns GetOneTimeTokenResponse|error

Get a One Time Token

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetOneTimeTokenResponse|error - OK

getParallelCalculationItem

Isolated FunctionRemote Function

function getParallelCalculationItem(string id, record {} payload, map<string|string[]> headers) returns GetParallelCalculationItemResponse|error

Get a Parallel Calculation Item

Parameters

id string - id of the Parallel Calculation Item (PCI) you want to retrieve

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetParallelCalculationItemResponse|error - OK

getPriceList

Isolated FunctionRemote Function

function getPriceList(string id, map<string|string[]> headers) returns GetPriceListResponse|error

Get a Price List

Parameters

id string - The ID of the Price List you want to retrieve details for. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetPriceListResponse|error - OK

getProductAttributeMeta

Isolated FunctionRemote Function

function getProductAttributeMeta(record {} payload, map<string|string[]> headers) returns ProductAttributeMetaEnvelope|error

Get Product Attribute Meta

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductAttributeMetaEnvelope|error - OK

getProductBomTree

Isolated FunctionRemote Function

function getProductBomTree(string sku, map<string|string[]> headers) returns ListBoMForProductResponse|error

List BoM for a Product

Parameters

sku string - The sku of the product you want to retrieve the Bill of Materials for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListBoMForProductResponse|error - OK

getProductCompetition

Isolated FunctionRemote Function

function getProductCompetition(GetCompetitionDataRequest payload, map<string|string[]> headers) returns GetCompetitionDataResponse|error

Get Competition Data

Parameters

payload GetCompetitionDataRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetCompetitionDataResponse|error - OK

getProductSetCompetition

Isolated FunctionRemote Function

function getProductSetCompetition(string label, GetProductSetRequest payload, map<string|string[]> headers) returns GetProductSetResponse|error

Get a Product Set

Parameters

label string - Enter the name of the product set you want to retrieve

payload GetProductSetRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetProductSetResponse|error - OK

getQueryApiMetadata

Isolated FunctionRemote Function

function getQueryApiMetadata(QueryapiExecuteBody payload, map<string|string[]> headers) returns QueryApiMetadataEnvelope|error

Get Query API Metadata

Parameters

payload QueryapiExecuteBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QueryApiMetadataEnvelope|error - Metadata returned

getQuote

Isolated FunctionRemote Function

function getQuote(string typedID, map<string|string[]> headers) returns QuoteResponse|error

Get a Quote

Parameters

typedID string - Enter the quote typed ID. You get the typedId in the response when fetching all quotes using the /quotemanager.fetchlist endpoint

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

getRebateAgreement

Isolated FunctionRemote Function

function getRebateAgreement(string uniqueName, map<string|string[]> headers) returns RebateAgreementResponse|error

Get a Rebate Agreement

Parameters

uniqueName string - The uniqueName of the Rebate Agreement you want to retrieve details for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RebateAgreementResponse|error - Example response

getRebateRecordGroup

Isolated FunctionRemote Function

function getRebateRecordGroup(record {} payload, map<string|string[]> headers) returns error?

Get a Rebate Record Group

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

getSellerExtension

Isolated FunctionRemote Function

function getSellerExtension(string sellerId, string sXCategory, map<string|string[]> headers) returns SellerExtensionEnvelope|error

Get a Seller Extension

Parameters

sellerId string - The SellerId of the seller in the Seller Extension table you want to retrieve details for

sXCategory string - The Seller Extension category (the Name from the Seller Master Extension table)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SellerExtensionEnvelope|error - OK

getSignatureStatus

Isolated FunctionRemote Function

function getSignatureStatus(string typedId, record {} payload, map<string|string[]> headers) returns GetSignatureStatusResponse|error

Get a Signature Status

Parameters

typedId string - typedId of the Compensation document you want to retrieve the signature status for

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetSignatureStatusResponse|error - OK

getSignedDocument

Isolated FunctionRemote Function

function getSignedDocument(string uniqueName, map<string|string[]> headers) returns Response|error

Get a Signed Document

Parameters

uniqueName string - A uniqueName of the Compensation Plan you want to download a signed file for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - OK

getStepCalculationStatus

Isolated FunctionRemote Function

function getStepCalculationStatus(string typedId, string stepName, map<string|string[]> headers) returns JobStatusTrackerResponse|error

Get a Step Calculation Status

Parameters

typedId string - The typedId of the Model Object you want to retrieve the calculation status for

stepName string - The name of the step you want to calculate

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobStatusTrackerResponse|error - Example response

getSummary

Isolated FunctionRemote Function

function getSummary(string typedId, record {} payload, map<string|string[]> headers) returns GetClaimItemsSummaryResponse|error

Get a Summary

Parameters

typedId string - The typedId to be sent with the request

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetClaimItemsSummaryResponse|error - OK

getTableInfo

Isolated FunctionRemote Function

function getTableInfo(string tableName, map<string|string[]> headers) returns GetKVTableInfoResponse|error

Get a Table Info

Parameters

tableName string - A name of the table you want to retrieve information about

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetKVTableInfoResponse|error - OK

getUploadProgress

Isolated FunctionRemote Function

function getUploadProgress(string uploadslot, map<string|string[]> headers) returns UploadSlotOperationEnvelope|error

Get Upload Progress

Parameters

uploadslot string - Upload Slot Id

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UploadSlotOperationEnvelope|error - The request response contains the current status of the upload slot, including progress information

getUserAuditReport

Isolated FunctionRemote Function

function getUserAuditReport("R"|"UG"|"BR"  typeCode, string id, record {} payload, map<string|string[]> headers) returns UserAuditReportEnvelope|error

Get a User Audit Report

Parameters

typeCode "R"|"UG"|"BR" - Specify whether you want to retrieve a report based on user roles (R), user groups (UG), or business roles (BR)

id string - Specify the idof the user role, user group, or business role for which you want to retrieve users. Call the /fetch/R, /fetch/UG, or /fetch/BR endpoint to retrieve a list with corresponding user roles, user groups, or business roles

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UserAuditReportEnvelope|error - OK

getWorkflowDocument

Isolated FunctionRemote Function

function getWorkflowDocument(string typedId, map<string|string[]> headers) returns GetWorkflowDocumentResponse|error

Get a Workflow Document

Parameters

typedId string - The typedId of the approvable object you want to retrieve workflow details for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GetWorkflowDocumentResponse|error - OK

importClicLineItems

Isolated FunctionRemote Function

function importClicLineItems(string typedId, ClicmanagerImportlineitemstypedIdBody payload, map<string|string[]> headers) returns ClicOperationEnvelope|error

Import Line Items (w/o Input Types)

Parameters

typedId string - The typedId to be sent with the request

payload ClicmanagerImportlineitemstypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ClicOperationEnvelope|error - OK - ServerMessageExtended property contains information about what was imported

importDataLoad

Isolated FunctionRemote Function

function importDataLoad(ImportDataLoadRequest payload, map<string|string[]> headers) returns error?

Import a Data Load

Parameters

payload ImportDataLoadRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

importDataMartFile

Isolated FunctionRemote Function

function importDataMartFile(string slotId, string typedId, map<string|string[]> headers) returns error?

Import a File

Parameters

slotId string - The id of the slot. Create the slot and retrieve the id using the /uploadmanager.newuploadslot endpoint

typedId string - The typedId of the Data Manager entity

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

importModels

Isolated FunctionRemote Function

function importModels(OptimizationModelimportBody payload, map<string|string[]> headers) returns ModelDuplicationEnvelope|error

Import Models

Parameters

payload OptimizationModelimportBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ModelDuplicationEnvelope|error - OK

importProductCompetition

Isolated FunctionRemote Function

function importProductCompetition(ImportCompetitionDataRequest payload, map<string|string[]> headers) returns ImportCompetitionDataResponse|error

Import Competition Data

Parameters

payload ImportCompetitionDataRequest - The competition product details

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ImportCompetitionDataResponse|error - OK

importSellerExtensionFile

Isolated FunctionRemote Function

function importSellerExtensionFile(string sXCategory, string slotId, ImportSXFileRequest payload, map<string|string[]> headers, *ImportSellerExtensionFileQueries queries) returns error?

Import a File

Parameters

sXCategory string - The Seller Extension category (the Name from the Seller Master Extension table)

slotId string - The ID that is returned by the /uploadmanager.newuploadslot (Create an Upload Slot) endpoint

payload ImportSXFileRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ImportSellerExtensionFileQueries - Queries to be sent with the request

Return Type

error? - Accepted

insertBulkCustomerExtensions

Isolated FunctionRemote Function

function insertBulkCustomerExtensions(InsertBulkCustomerExtensionsRequest payload, map<string|string[]> headers) returns LoadDataResponse|error

Insert Bulk Customer Extensions

Parameters

payload InsertBulkCustomerExtensionsRequest - Specify customer extension field names in the header object and field values in the data object.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LoadDataResponse|error - Returns the number of inserted or updated objects

insertBulkData

Isolated FunctionRemote Function

function insertBulkData(TypeCodeEnum typeCode, InsertBulkDataRequest payload, map<string|string[]> headers) returns LoadDataResponse|error

Insert Bulk Data

Parameters

typeCode TypeCodeEnum - Specify the type code for the entity you want to work with. See the list of Type Codes in the Pricefx Knowledge Base article.'

payload InsertBulkDataRequest - The /loaddata/P endpoint (Insert Bulk Products) is used in our example.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LoadDataResponse|error - Returns the number of inserted or updated objects

insertBulkDataFromFile

Isolated FunctionRemote Function

function insertBulkDataFromFile("C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG"  typeCode, InsertBulkDataFromFileRequest payload, map<string|string[]> headers, *InsertBulkDataFromFileQueries queries) returns InsertBulkDataFromFileResponse|error

Insert Bulk Data From a File

Parameters

typeCode "C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG" - Enter the type code of the entity you want to insert a data to. See the list of Type Codes in the Pricefx Knowledge Base article

payload InsertBulkDataFromFileRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *InsertBulkDataFromFileQueries - Queries to be sent with the request

Return Type

InsertBulkDataFromFileResponse|error - OK

insertBulkDataFromFileAsync

Isolated FunctionRemote Function

function insertBulkDataFromFileAsync("C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG"  typeCode, InsertBulkDataFromFileAsyncRequest payload, map<string|string[]> headers, *InsertBulkDataFromFileAsyncQueries queries) returns InsertBulkDataFromFileAsyncResponse|error

Insert Bulk Data From a File (async)

Parameters

typeCode "C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG" - Enter the type code of the entity you want to insert a data to. See the list of Type Codes in the Pricefx Knowledge Base article

payload InsertBulkDataFromFileAsyncRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *InsertBulkDataFromFileAsyncQueries - Queries to be sent with the request

Return Type

InsertBulkDataFromFileAsyncResponse|error - OK

insertBulkDataToLookupTable

Isolated FunctionRemote Function

function insertBulkDataToLookupTable("JLTV"|"JLTVM"|"LT"|"LTT"|"LTV"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"  typeCode, InsertBulkDataToLookupTableRequest payload, map<string|string[]> headers) returns InsertBulkDataLookupTableResponse|error

Insert Bulk Data to Lookup Table

Parameters

typeCode "JLTV"|"JLTVM"|"LT"|"LTT"|"LTV"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM" - Enter the type code of the Lookup Table entity you want to insert a data to

payload InsertBulkDataToLookupTableRequest - We used /lookuptablemanager.loaddata/MLTV in the request example to insert bulk data to Matrix Lookup Table. Notice that the lookupTable is used in the header section and then ID of the Lookup Table in the data section

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

InsertBulkDataLookupTableResponse|error - OK

insertBulkKvData

Isolated FunctionRemote Function

function insertBulkKvData(string tableName, InsertBulkKVDataRequest payload, map<string|string[]> headers) returns GenericDataResponse|error

Insert Bulk KV Data

Parameters

tableName string - A name of the table you want upload data to

payload InsertBulkKVDataRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

insertBulkProductExtensions

Isolated FunctionRemote Function

function insertBulkProductExtensions(InsertBulkProductExtensionsRequest payload, map<string|string[]> headers) returns error?

Insert Bulk Product Extensions

Parameters

payload InsertBulkProductExtensionsRequest - Specify product extension field names in the header object and field values in the data object

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

insertBulkSellerExtensions

Isolated FunctionRemote Function

function insertBulkSellerExtensions(InsertBulkProductExtensionsRequest1 payload, map<string|string[]> headers) returns error?

Insert Bulk Seller Extensions

Parameters

payload InsertBulkProductExtensionsRequest1 - Specify seller extension field names in the header object and field values in the data object

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

listAccrualRecords

Isolated FunctionRemote Function

function listAccrualRecords(ListAccrualRecordsRequest payload, map<string|string[]> headers) returns ListAccrualRecordsResponse|error

List Accrual Records

Parameters

payload ListAccrualRecordsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListAccrualRecordsResponse|error - OK

listActionItems

Isolated FunctionRemote Function

function listActionItems(FetchAIBody payload, map<string|string[]> headers) returns ListActionItemsResponse|error

List Action Items

Parameters

payload FetchAIBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListActionItemsResponse|error - OK

listActionTypes

Isolated FunctionRemote Function

function listActionTypes(record { endRow int, oldValues record {}?, operationType string, startRow int, textMatchStyle string, data record { _constructor string, operator string, criteria record { fieldName string, operator string, value string }[] } } payload, map<string|string[]> headers) returns ListActionTypesResponse|error

List Action Types

Parameters

payload record { endRow int, oldValues record {}?, operationType string, startRow int, textMatchStyle string, data record { _constructor string, operator string, criteria record { fieldName string, operator string, value string }[] } } - A general fetch request. A filter can be applied

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListActionTypesResponse|error - OK

listAllLookupTableValues

Isolated FunctionRemote Function

function listAllLookupTableValues(string tableId, ListAllLookupTableValuesRequest payload, map<string|string[]> headers, *ListAllLookupTableValuesQueries queries) returns ListAllLookupTableValuesResponse|error

List All Lookup Table Values

Parameters

tableId string - Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method

payload ListAllLookupTableValuesRequest - You can specify the start and end row to limit the number of retrieved records

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListAllLookupTableValuesQueries - Queries to be sent with the request

Return Type

ListAllLookupTableValuesResponse|error - OK

listAllLookupTables

Isolated FunctionRemote Function

function listAllLookupTables(ListAllLookupTablesRequest payload, map<string|string[]> headers) returns ListAllLookupTablesResponse|error

List All Lookup Tables

Parameters

payload ListAllLookupTablesRequest - You can specify the start and end row to limit the number of retrieved Lookup Tables / Company Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListAllLookupTablesResponse|error - Returns the Company Parameter table / Lookup table fields. The name property is the same as uniqueName if the owner is null. If the owner field is non-null, then the name will be the name of the table (DMT or LT) in the context of the owner

listAttributeFieldsMetadata

Isolated FunctionRemote Function

function listAttributeFieldsMetadata("ACTT"|"AI"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CL"|"CLLI"|"CLLIAM"|"CLR"|"CLT"|"CN"|"CO"|"COAM"|"COCT"|"COCTAM"|"COHT"|"COHTAM"|"COLI"|"COR"|"CORAM"|"COROLI"|"CORS"|"CORSC"|"COT"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX10"|"CX20"|"CX3"|"CX30"|"CX50"|"CX6"|"CX8"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DP"|"DPR"|"DPT"|"DREF"|"DREG"|"EDL"|"ET"|"EVT"|"F"|"FE"|"FN"|"HEVT"|"HRT"|"HRTAM"|"IDC"|"IE"|"ISH"|"JLTV"|"JLTV2"|"JLTVM"|"JST"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MC"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MN"|"MO"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"NT"|"P"|"PAM"|"PBOME"|"PCOMP"|"PCOMPCO"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLPGTT"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX10"|"PX20"|"PX3"|"PX30"|"PX50"|"PX6"|"PX8"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAROLI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"SL"|"SLAM"|"SX10"|"SX20"|"SX3"|"SX30"|"SX50"|"SX6"|"SX8"|"SXAM"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI"  typeCode, map<string|string[]> headers, *ListAttributeFieldsMetadataQueries queries) returns ListAttributeFieldsMetadata|error

List Attribute Fields' Metadata

Parameters

typeCode "ACTT"|"AI"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CL"|"CLLI"|"CLLIAM"|"CLR"|"CLT"|"CN"|"CO"|"COAM"|"COCT"|"COCTAM"|"COHT"|"COHTAM"|"COLI"|"COR"|"CORAM"|"COROLI"|"CORS"|"CORSC"|"COT"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX10"|"CX20"|"CX3"|"CX30"|"CX50"|"CX6"|"CX8"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DP"|"DPR"|"DPT"|"DREF"|"DREG"|"EDL"|"ET"|"EVT"|"F"|"FE"|"FN"|"HEVT"|"HRT"|"HRTAM"|"IDC"|"IE"|"ISH"|"JLTV"|"JLTV2"|"JLTVM"|"JST"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MC"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MN"|"MO"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"NT"|"P"|"PAM"|"PBOME"|"PCOMP"|"PCOMPCO"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLPGTT"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX10"|"PX20"|"PX3"|"PX30"|"PX50"|"PX6"|"PX8"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAROLI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"SL"|"SLAM"|"SX10"|"SX20"|"SX3"|"SX30"|"SX50"|"SX6"|"SX8"|"SXAM"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" - Enter the type code of the entity you want to retrieve information for. See the list of Type Codes in the Pricefx Knowledge Base article

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListAttributeFieldsMetadataQueries - Queries to be sent with the request

Return Type

ListAttributeFieldsMetadata|error - OK

listCalculatedFieldSets

Isolated FunctionRemote Function

function listCalculatedFieldSets(map<string|string[]> headers) returns ListCalculatedFieldSetsResponse|error

List Calculated Field Sets

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCalculatedFieldSetsResponse|error - OK

listCalculationGridItems

Isolated FunctionRemote Function

function listCalculationGridItems("1"|"2"|"3"|"4"|"5"|"6"  keyNumber, ListCalculationGridItemsRequest payload, map<string|string[]> headers) returns ListCalculationGridItemsResponse|error

List Calculation Grid Items

Parameters

keyNumber "1"|"2"|"3"|"4"|"5"|"6" - Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys

payload ListCalculationGridItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCalculationGridItemsResponse|error - OK

listCalculationGrids

Isolated FunctionRemote Function

function listCalculationGrids(record {} payload, map<string|string[]> headers) returns ListCalculationGridsResponse|error

List Calculation Grids

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCalculationGridsResponse|error - OK

listCalculations

Isolated FunctionRemote Function

function listCalculations(ListCalculationsRequest payload, map<string|string[]> headers) returns ListCalculationsResponse|error

List Calculations

Parameters

payload ListCalculationsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCalculationsResponse|error - OK

listCharts

Isolated FunctionRemote Function

function listCharts(map<string|string[]> headers) returns ListChartsResponse|error

List Charts

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListChartsResponse|error - OK

listClaimTypes

Isolated FunctionRemote Function

function listClaimTypes(ListClaimTypesRequest payload, map<string|string[]> headers) returns ListClaimTypesResponse|error

List Claim Types

Parameters

payload ListClaimTypesRequest - The example of the request body contains the filter. The call returns Claim Types whose name equals to "claimType"

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListClaimTypesResponse|error - OK

listClaims

Isolated FunctionRemote Function

function listClaims(ListClaimsRequest payload, map<string|string[]> headers) returns ListClaimsResponse|error

List Claims

Parameters

payload ListClaimsRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListClaimsResponse|error - OK

listClicObjects

Isolated FunctionRemote Function

function listClicObjects(string typedId, GetCLICrequest payload, map<string|string[]> headers, *ListClicObjectsQueries queries) returns GetCLICresponse|error

List CLIC Objects

Parameters

typedId string - The typedId of the Quote/Contract/Rebate Agreement/Compensation Plan you want to retrieve line items for

payload GetCLICrequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListClicObjectsQueries - Queries to be sent with the request

Return Type

GetCLICresponse|error - OK

listCommentThreads

Isolated FunctionRemote Function

function listCommentThreads(string typedId, CommentmanagerFetchthreadstypedIdBody payload, map<string|string[]> headers, *ListCommentThreadsQueries queries) returns ListCommentThreadsEnvelope|error

List Comment Threads

Parameters

typedId string - typedId of the object you want to fetch comments for

payload CommentmanagerFetchthreadstypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListCommentThreadsQueries - Queries to be sent with the request

Return Type

ListCommentThreadsEnvelope|error - OK

listCompensationPlans

Isolated FunctionRemote Function

function listCompensationPlans(ListCompensationPlansRequest payload, map<string|string[]> headers) returns ListCompensationPlansResponse|error

List Compensation Plans

Parameters

payload ListCompensationPlansRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCompensationPlansResponse|error - OK

listCompensationRecords

Isolated FunctionRemote Function

function listCompensationRecords(string compensationRecordSetId, ListCompensationRecordsRequest payload, map<string|string[]> headers) returns ListCompensationRecordsResponse|error

List Compensation Records

Parameters

compensationRecordSetId string - ID of the CompensationRecordSet into which this Compensation Record belongs. By default it belongs to "Default" CompensationRecordSet, but you can change it when you create the Compensation Record. This can be useful if you create different "kinds" of Compensation Records which will be used to calculate different results at different times

payload ListCompensationRecordsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCompensationRecordsResponse|error - OK

listCompensationTypes

Isolated FunctionRemote Function

function listCompensationTypes(ListCompensationTypesRequest payload, map<string|string[]> headers) returns ListCompensationTypesEnvelope|error

List Compensation Types

Parameters

payload ListCompensationTypesRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCompensationTypesEnvelope|error - OK

listConditionRecordSets

Isolated FunctionRemote Function

function listConditionRecordSets(record {} payload, map<string|string[]> headers) returns ListConditionRecordSetsEnvelope|error

List Condition Record Sets

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListConditionRecordSetsEnvelope|error - OK

listConditionTypes

Isolated FunctionRemote Function

function listConditionTypes(ListConditionTypesRequest payload, map<string|string[]> headers) returns ListConditionTypesEnvelope|error

List Condition Types

Parameters

payload ListConditionTypesRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListConditionTypesEnvelope|error - OK

listContractCalculations

Isolated FunctionRemote Function

function listContractCalculations(record {} payload, map<string|string[]> headers) returns ListContractCalculationsEnvelope|error

List Contract Calculations

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListContractCalculationsEnvelope|error - OK

listContractPriceRecords

Isolated FunctionRemote Function

function listContractPriceRecords(FetchCPRBody payload, map<string|string[]> headers) returns ListContractPriceRecords|error

List Contract Price Records

Parameters

payload FetchCPRBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListContractPriceRecords|error - OK

listContracts

Isolated FunctionRemote Function

function listContracts(ListContractsRequest payload, map<string|string[]> headers) returns ContractResponse|error

List Contracts

Parameters

payload ListContractsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ContractResponse|error - Example response

listCustomFormTypes

Isolated FunctionRemote Function

function listCustomFormTypes(ListCustomFormTypesRequest payload, map<string|string[]> headers) returns ListCustomFormTypesResponse|error

List Custom Form Types

Parameters

payload ListCustomFormTypesRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCustomFormTypesResponse|error - OK

listCustomForms

Isolated FunctionRemote Function

function listCustomForms(ListCustomFormsRequest payload, map<string|string[]> headers) returns ListCustomFormsEnvelope|error

List Custom Forms

Parameters

payload ListCustomFormsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListCustomFormsEnvelope|error - OK

listCustomerAssignments

Isolated FunctionRemote Function

function listCustomerAssignments(string typedId, ListCustomerAssignmentsRequest payload, map<string|string[]> headers) returns AssignmentResponse|error

List Customer Assignments

Parameters

typedId string - The typedId of the entity you want to retrieve assignments for

payload ListCustomerAssignmentsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AssignmentResponse|error - Example response

listCustomerExtensionObjects

Isolated FunctionRemote Function

function listCustomerExtensionObjects(string customerMasterExtensionName, ListCustomerExtensionObjectsRequest payload, map<string|string[]> headers, *ListCustomerExtensionObjectsQueries queries) returns ListCustomerExtensionObjectsResponse|error

List Customer Extension Objects

Parameters

customerMasterExtensionName string - Enter the name of Customer Extension you want to retrieve objects from. You can find the name in Administration > Configuration > Master Data > Customer Master Extension or using the /configurationmanager.get/customerextension endpoint

payload ListCustomerExtensionObjectsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListCustomerExtensionObjectsQueries - Queries to be sent with the request

Return Type

ListCustomerExtensionObjectsResponse|error - OK

listCustomers

Isolated FunctionRemote Function

function listCustomers(ListCustomersRequest payload, map<string|string[]> headers) returns CustomerResponse|error

List Customers

Parameters

payload ListCustomersRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomerResponse|error - Returns customer record details

listDataLoads

Isolated FunctionRemote Function

function listDataLoads(map<string|string[]> headers) returns ListDataLoadsResponse|error

List Data Loads

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListDataLoadsResponse|error - OK

listDataLoadsWith

Isolated FunctionRemote Function

function listDataLoadsWith(map<string|string[]> headers) returns ListDataLoadsWithValidationResponse|error

List Data Loads (with validation and schedules)

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListDataLoadsWithValidationResponse|error - OK

listDataManagerEntities

Isolated FunctionRemote Function

function listDataManagerEntities("DM"|"DMDS"|"DMF"|"DMT"  typeCode, ListDataManagerEntitiesRequest payload, map<string|string[]> headers) returns DmObjectResponse|error

List Data Manager Entities

Parameters

typeCode "DM"|"DMDS"|"DMF"|"DMT" - The type code of the Field Collection

payload ListDataManagerEntitiesRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DmObjectResponse|error - Example response

listDatamartOrphanObjects

Isolated FunctionRemote Function

function listDatamartOrphanObjects(map<string|string[]> headers) returns DatamartOrphanObjectsEnvelope|error

List Datamart Orphan Objects

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DatamartOrphanObjectsEnvelope|error - OK

listDelegatedWorkflows

Isolated FunctionRemote Function

function listDelegatedWorkflows(ListDelegatedWorkflowsRequest payload, map<string|string[]> headers) returns ListDelegatedWorkflowsResponse|error

List Delegated Workflows

Parameters

payload ListDelegatedWorkflowsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListDelegatedWorkflowsResponse|error - OK

listElements

Isolated FunctionRemote Function

function listElements(string uniqueName, map<string|string[]> headers) returns ListElementsResponse|error

List Elements

Parameters

uniqueName string - The name (uniqueName) of the logic you want to list elements for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListElementsResponse|error - OK

listEmailTasks

Isolated FunctionRemote Function

function listEmailTasks(NotificationListBody payload, map<string|string[]> headers) returns ListEmailTasksEnvelope|error

List Email Tasks

Parameters

payload NotificationListBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListEmailTasksEnvelope|error - OK

listEntityFields

Isolated FunctionRemote Function

function listEntityFields("ACTT"|"AI"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CL"|"CLLI"|"CLLIAM"|"CLR"|"CLT"|"CN"|"CO"|"COAM"|"COCT"|"COCTAM"|"COHT"|"COHTAM"|"COLI"|"COR"|"CORAM"|"COROLI"|"CORS"|"CORSC"|"COT"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX10"|"CX20"|"CX3"|"CX30"|"CX50"|"CX6"|"CX8"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DP"|"DPR"|"DPT"|"DREF"|"DREG"|"EDL"|"ET"|"EVT"|"F"|"FE"|"FN"|"HEVT"|"HRT"|"HRTAM"|"IDC"|"IE"|"ISH"|"JLTV"|"JLTV2"|"JLTVM"|"JST"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MC"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MN"|"MO"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"NT"|"P"|"PAM"|"PBOME"|"PCOMP"|"PCOMPCO"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLPGTT"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX10"|"PX20"|"PX3"|"PX30"|"PX50"|"PX6"|"PX8"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAROLI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"SL"|"SLAM"|"SX10"|"SX20"|"SX3"|"SX30"|"SX50"|"SX6"|"SX8"|"SXAM"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI"  typeCode, map<string|string[]> headers, *ListEntityFieldsQueries queries) returns ListEntityFieldsResponse|error

List Entity Fields

Parameters

typeCode "ACTT"|"AI"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CL"|"CLLI"|"CLLIAM"|"CLR"|"CLT"|"CN"|"CO"|"COAM"|"COCT"|"COCTAM"|"COHT"|"COHTAM"|"COLI"|"COR"|"CORAM"|"COROLI"|"CORS"|"CORSC"|"COT"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX10"|"CX20"|"CX3"|"CX30"|"CX50"|"CX6"|"CX8"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DP"|"DPR"|"DPT"|"DREF"|"DREG"|"EDL"|"ET"|"EVT"|"F"|"FE"|"FN"|"HEVT"|"HRT"|"HRTAM"|"IDC"|"IE"|"ISH"|"JLTV"|"JLTV2"|"JLTVM"|"JST"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MC"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MN"|"MO"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"NT"|"P"|"PAM"|"PBOME"|"PCOMP"|"PCOMPCO"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLPGTT"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX10"|"PX20"|"PX3"|"PX30"|"PX50"|"PX6"|"PX8"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAROLI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"SL"|"SLAM"|"SX10"|"SX20"|"SX3"|"SX30"|"SX50"|"SX6"|"SX8"|"SXAM"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" - Enter the type code of the entity you want to retrieve information for. See the list of Type Codes in the Pricefx Knowledge Base article

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListEntityFieldsQueries - Queries to be sent with the request

Return Type

ListEntityFieldsResponse|error - OK

listEventTasks

Isolated FunctionRemote Function

function listEventTasks(NotificationListBody payload, map<string|string[]> headers) returns ListEventTasksEnvelope|error

List Event Tasks

Parameters

payload NotificationListBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListEventTasksEnvelope|error - OK

listFiles

Isolated FunctionRemote Function

function listFiles(string typedId, BdmanagerListtypedIdBody payload, map<string|string[]> headers) returns ListFilesEnvelope|error

List Files

Parameters

typedId string - typedId of the document you want to list attachments for

payload BdmanagerListtypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListFilesEnvelope|error - OK

listFunctions

Isolated FunctionRemote Function

function listFunctions(map<string|string[]> headers) returns ListFunctionsResponse|error

List Functions

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListFunctionsResponse|error - OK

listGroupsOfBusinessRole

Isolated FunctionRemote Function

function listGroupsOfBusinessRole(string businessroleId, map<string|string[]> headers) returns ListGroupsOfBusinessRoleResponse|error

List Groups of the Business Role

Parameters

businessroleId string - The ID of the business role you want to retrieve user roles for. The businessroleId is the typedId without the BR suffix. For example, businessroleId of the 53.BR is 53

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListGroupsOfBusinessRoleResponse|error - OK

listImportManagerChanges

Isolated FunctionRemote Function

function listImportManagerChanges(string uniqueName, record {} payload, map<string|string[]> headers) returns ListImportManagerChangesEnvelope|error

List ImportManager Changes

Parameters

uniqueName string - The uniqueName to be sent with the request

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListImportManagerChangesEnvelope|error - OK

listInternationalizationMessages

Isolated FunctionRemote Function

function listInternationalizationMessages(I18nmanagerFetchWithExtraDataBody payload, map<string|string[]> headers) returns ListInternationalizationMessagesEnvelope|error

List Internationalization Messages

Parameters

payload I18nmanagerFetchWithExtraDataBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListInternationalizationMessagesEnvelope|error - OK - contains the messages for the locale

listItems

Isolated FunctionRemote Function

function listItems(string typedId, record {} payload, map<string|string[]> headers) returns ListClaimItemsResponse|error

List Items

Parameters

typedId string - The typedId to be sent with the request

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListClaimItemsResponse|error - OK

listJobs

Isolated FunctionRemote Function

function listJobs(record { endRow int, oldValues record {}?, operationType string, startRow int, textMatchStyle string, data record { _constructor string, operator string, criteria record { fieldName string, operator string, value string }[] } } payload, map<string|string[]> headers) returns ListJSTResponse|error

List Jobs

Parameters

payload record { endRow int, oldValues record {}?, operationType string, startRow int, textMatchStyle string, data record { _constructor string, operator string, criteria record { fieldName string, operator string, value string }[] } } - A general fetch request. A filter can be applied

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListJSTResponse|error - OK

listKvTables

Isolated FunctionRemote Function

function listKvTables(map<string|string[]> headers) returns ListKVTablesResponse|error

List KV Tables

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListKVTablesResponse|error - OK

listLibraries

Isolated FunctionRemote Function

function listLibraries(map<string|string[]> headers) returns ListLibrariesResponse|error

List Libraries

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListLibrariesResponse|error - OK

listLivePriceGridItems

Isolated FunctionRemote Function

function listLivePriceGridItems(string id, ListLivePriceGridItemsRequest payload, map<string|string[]> headers) returns ListLivePriceGridItemsResponse|error

List Live Price Grid Items

Parameters

id string - The id of the Live Price Grid you want to retrieve items for. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

payload ListLivePriceGridItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListLivePriceGridItemsResponse|error - OK

listLivePriceGridTypes

Isolated FunctionRemote Function

function listLivePriceGridTypes(map<string|string[]> headers) returns ListLivePriceGridTypesEnvelope|error

List Live Price Grid Types

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListLivePriceGridTypesEnvelope|error - OK

listLivePriceGrids

Isolated FunctionRemote Function

function listLivePriceGrids(ListLivePriceGridsRequest payload, map<string|string[]> headers) returns ListLivePriceGridsResponse|error

List Live Price Grids

Parameters

payload ListLivePriceGridsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListLivePriceGridsResponse|error - OK

listLogicParametersInput

Isolated FunctionRemote Function

function listLogicParametersInput(string uniqueName, map<string|string[]> headers) returns ListLogicInputFieldsResponse|error

List Logic Parameters (Input Fields)

Parameters

uniqueName string - The name (uniqueName) of the logic you want to list parameters for. If omitted, the logic as specified in the product’s master is used, otherwise the passed logic is used

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListLogicInputFieldsResponse|error - OK

listLogics

Isolated FunctionRemote Function

function listLogics(map<string|string[]> headers) returns ListLogicsResponse|error

List Logics

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListLogicsResponse|error - OK

listLogins

Isolated FunctionRemote Function

function listLogins(BdmanagerListtypedIdBody payload, map<string|string[]> headers) returns ListLoginsEnvelope|error

List Logins

Parameters

payload BdmanagerListtypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListLoginsEnvelope|error - OK

listManualPriceListProducts

Isolated FunctionRemote Function

function listManualPriceListProducts(string id, ListProductsFromManualPriceListRequest payload, map<string|string[]> headers) returns ListProductsFromManualPriceListResponse|error

List Products From a Manual Price List

Parameters

id string - The ID of the Manual Price List you want to retrieve products from

payload ListProductsFromManualPriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListProductsFromManualPriceListResponse|error - OK

listManualPriceLists

Isolated FunctionRemote Function

function listManualPriceLists(ListManualPriceListsRequest payload, map<string|string[]> headers) returns ManualPriceListResponse|error

List Manual Price Lists

Parameters

payload ListManualPriceListsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ManualPriceListResponse|error - Example response

listModelLogicParameters

Isolated FunctionRemote Function

function listModelLogicParameters(string typedId, string stepName, string formulaName, map<string|string[]> headers) returns ListModelLogicParametersResponse|error

List Model Logic Parameters

Parameters

typedId string - The typedId of the Model Object you want to retrieve logic parameters for

stepName string - The name of the step you want to list logic parameters for

formulaName string - The name of the logic you want to get parameters for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListModelLogicParametersResponse|error - OK

listNotifications

Isolated FunctionRemote Function

function listNotifications(NotificationListBody payload, map<string|string[]> headers) returns ListNotificationsEnvelope|error

List Notifications

Parameters

payload NotificationListBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListNotificationsEnvelope|error - OK

listObjects

Isolated FunctionRemote Function

function listObjects(string typeCode, ListObjectsRequest payload, map<string|string[]> headers) returns GenericDataResponse|error

List Objects

Parameters

typeCode string - The object's type code. See the list of Type Codes

payload ListObjectsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

listParallelCalculationItems

Isolated FunctionRemote Function

function listParallelCalculationItems(ListParallelCalculationItemsRequest payload, map<string|string[]> headers) returns ListParallelCalculationItemsResponse|error

List Parallel Calculation Items

Parameters

payload ListParallelCalculationItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListParallelCalculationItemsResponse|error - OK

listPendingApprovals

Isolated FunctionRemote Function

function listPendingApprovals(map<string|string[]> headers) returns ListPendingApprovalsResponse|error

List Pending Approvals

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListPendingApprovalsResponse|error - OK

listPriceListItems

Isolated FunctionRemote Function

function listPriceListItems(string id, ListPriceListItemsRequest payload, map<string|string[]> headers) returns PriceListItemResponse|error

List Price List Items

Parameters

id string - The ID of the Price List you want to retrieve items for. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

payload ListPriceListItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceListItemResponse|error - Example response

listPriceListTypes

Isolated FunctionRemote Function

function listPriceListTypes(map<string|string[]> headers) returns ListPriceListTypesEnvelope|error

List Price List Types

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListPriceListTypesEnvelope|error - OK

listPriceLists

Isolated FunctionRemote Function

function listPriceLists(ListPriceListsRequest payload, map<string|string[]> headers) returns ListPriceListsResponse|error

List Price Lists

Parameters

payload ListPriceListsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListPriceListsResponse|error - OK

listProductExtensionObjects

Isolated FunctionRemote Function

function listProductExtensionObjects(string productMasterExtensionName, ListProductExtensionObjectsRequest payload, map<string|string[]> headers, *ListProductExtensionObjectsQueries queries) returns ProductExtensionResponse|error

List Product Extension Objects

Parameters

productMasterExtensionName string - Enter the name of Product Extension you want to retrieve objects from. You can find the name in Administration > Configuration > Master Data > Product Master Extension or using the /configurationmanager.get/productextension endpoint

payload ListProductExtensionObjectsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListProductExtensionObjectsQueries - Queries to be sent with the request

Return Type

ProductExtensionResponse|error - A Product Extension response

listProductSets

Isolated FunctionRemote Function

function listProductSets(ListProductSetsRequest payload, map<string|string[]> headers) returns ListProductSetsResponse|error

List Product Sets

Parameters

payload ListProductSetsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListProductSetsResponse|error - OK

listProducts

Isolated FunctionRemote Function

function listProducts(ListProductsRequest payload, map<string|string[]> headers) returns ProductResponse|error

List Products

Parameters

payload ListProductsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

listQuoteProducts

Isolated FunctionRemote Function

function listQuoteProducts(ListProductsRequest1 payload, map<string|string[]> headers) returns error?

List Products

Parameters

payload ListProductsRequest1 - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

listQuotes

Isolated FunctionRemote Function

function listQuotes(ListQuotesRequest payload, map<string|string[]> headers) returns ListQuotesResponse|error

List Quotes

Parameters

payload ListQuotesRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListQuotesResponse|error - OK

listRebateAgreementItems

Isolated FunctionRemote Function

function listRebateAgreementItems(ListRebateAgreementItemsRequest payload, map<string|string[]> headers) returns ListRebateAgreementItemsResponse|error

List Rebate Agreement Items

Parameters

payload ListRebateAgreementItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListRebateAgreementItemsResponse|error - OK

listRebateAgreements

Isolated FunctionRemote Function

function listRebateAgreements(ListRebateAgreementsRequest payload, map<string|string[]> headers) returns ListRebateAgreementsResponse|error

List Rebate Agreements

Parameters

payload ListRebateAgreementsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListRebateAgreementsResponse|error - OK

listRebateCalculations

Isolated FunctionRemote Function

function listRebateCalculations(FetchRRSCBody payload, map<string|string[]> headers) returns ListRebateCalculationsResponse|error

List Rebate Calculations

Parameters

payload FetchRRSCBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListRebateCalculationsResponse|error - OK

listRecommendations

Isolated FunctionRemote Function

function listRecommendations(ListRecommendationsRequest payload, map<string|string[]> headers) returns ListRecommendationsEnvelope|error

List Recommendations

Parameters

payload ListRecommendationsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListRecommendationsEnvelope|error - OK

listRolesOfBusinessRole

Isolated FunctionRemote Function

function listRolesOfBusinessRole(string businessroleId, map<string|string[]> headers) returns ListRolesOfBusinessRoleResponse|error

List Roles of the Business Role

Parameters

businessroleId string - The ID of the business role you want to retrieve user roles for. The businessroleId is the typedId without the BR suffix. For example, businessroleId of the 53.BR is 53

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListRolesOfBusinessRoleResponse|error - OK

listRollups

Isolated FunctionRemote Function

function listRollups(ListRollupsRequest payload, map<string|string[]> headers) returns ListRollupsResponse|error

List Rollups

Parameters

payload ListRollupsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListRollupsResponse|error - OK

listSecurityConfigurationEvents

Isolated FunctionRemote Function

function listSecurityConfigurationEvents(NotificationListBody payload, map<string|string[]> headers) returns ListSecurityConfigEventsEnvelope|error

List Security & Configuration Events

Parameters

payload NotificationListBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListSecurityConfigEventsEnvelope|error - OK

listSellerExtensions

Isolated FunctionRemote Function

function listSellerExtensions(string sXCategory, map<string|string[]> headers) returns SellerExtensionEnvelope|error

List Seller Extensions

Parameters

sXCategory string - The Seller Extension category (the Name from the Seller Master Extension table)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SellerExtensionEnvelope|error - OK

listSellers

Isolated FunctionRemote Function

function listSellers(ListSellersRequest payload, map<string|string[]> headers) returns ListSellersEnvelope|error

List Sellers

Parameters

payload ListSellersRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListSellersEnvelope|error - OK

listTasks

Isolated FunctionRemote Function

function listTasks(map<string|string[]> headers) returns GenericDataResponse|error

List Tasks

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

listTypeCodes

Isolated FunctionRemote Function

function listTypeCodes(map<string|string[]> headers) returns TypeCodesResponse|error?

List Type Codes

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

TypeCodesResponse|error? - Example response

listUniqueClicItems

Isolated FunctionRemote Function

function listUniqueClicItems(string typedId, record {} payload, map<string|string[]> headers) returns ListUniqueCLICItemsResponse|error

List Unique CLIC Items

Parameters

typedId string - The typedId to be sent with the request

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListUniqueCLICItemsResponse|error - OK

listUserSBusinessRoles

Isolated FunctionRemote Function

function listUserSBusinessRoles(string userId, map<string|string[]> headers) returns ListUserBusinessRolesResponse|error

List User's Business Roles

Parameters

userId string - The ID of the user you want to retrieve business roles for. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListUserBusinessRolesResponse|error - OK

listUserSPendingApprovals

Isolated FunctionRemote Function

function listUserSPendingApprovals(string loginName, map<string|string[]> headers) returns ListUserPendingApprovalsResponse|error

List User's Pending Approvals

Parameters

loginName string - The login name of the user you want to retrieve Pending Workflows for

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListUserPendingApprovalsResponse|error - OK

listUserSRoles

Isolated FunctionRemote Function

function listUserSRoles(string userId, map<string|string[]> headers) returns ListUserRolesResponse|error

List User's Roles

Parameters

userId string - The ID of the user you want to retrieve roles for. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListUserRolesResponse|error - OK

listUserSUserGroups

Isolated FunctionRemote Function

function listUserSUserGroups(string userId, map<string|string[]> headers) returns ListUsersUserGroupsResponse|error

List User's User Groups

Parameters

userId string - The ID of the user you want to retrieve groups for. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListUsersUserGroupsResponse|error - OK

listUsers

Isolated FunctionRemote Function

function listUsers(ListUsersRequest payload, map<string|string[]> headers) returns ListUsersResponse|error

List Users

Parameters

payload ListUsersRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListUsersResponse|error - OK

listWorkflows

Isolated FunctionRemote Function

function listWorkflows(ListWorkflowsRequest payload, map<string|string[]> headers) returns ListWorkflowsResponse|error

List Workflows

Parameters

payload ListWorkflowsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ListWorkflowsResponse|error - OK

loadDataIntoFieldCollection

Isolated FunctionRemote Function

function loadDataIntoFieldCollection(string typedId, DatamartLoadfctypedIdBody payload, map<string|string[]> headers) returns Response|error

Load Data Into FieldCollection

Parameters

typedId string - Specifies the typedId (format: {id}.{type}) of the FieldCollection to load data into. Type must be either DMDS or DMT

payload DatamartLoadfctypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - OK - data loaded successfully into the DMFieldCollection

markAsRead

Isolated FunctionRemote Function

function markAsRead(record {} payload, map<string|string[]> headers) returns GenericDataResponse|error

Mark as Read

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

markQuoteLost

Isolated FunctionRemote Function

function markQuoteLost(string identifier, MarkOfferAsLostRequest payload, map<string|string[]> headers) returns QuoteResponse|error

Mark an Offer as Lost

Parameters

identifier string - Can be either the uniqueName or the typedId

payload MarkOfferAsLostRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

massDeleteImports

Isolated FunctionRemote Function

function massDeleteImports(string typedId, ImportmanagerMassdeletetypedIdBody payload, map<string|string[]> headers) returns MassDeleteImportsEnvelope|error

Mass Delete Imports

Parameters

typedId string - The typedId to be sent with the request

payload ImportmanagerMassdeletetypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassDeleteImportsEnvelope|error - OK

massDeleteLookupTableValues

Isolated FunctionRemote Function

function massDeleteLookupTableValues(string tableId, TableIdBatchBody payload, map<string|string[]> headers, *MassDeleteLookupTableValuesQueries queries) returns DeleteLookupTableValueResponse1|error

Mass Delete Lookup Table Values

Parameters

tableId string - Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method

payload TableIdBatchBody -

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *MassDeleteLookupTableValuesQueries - Queries to be sent with the request

Return Type

DeleteLookupTableValueResponse1|error - OK

massEditDataChangeRequestItems

Isolated FunctionRemote Function

function massEditDataChangeRequestItems(string id, DcrmanagerAddmassopidBody payload, map<string|string[]> headers) returns DataChangeRequestMassChangeEnvelope|error

Mass Edit Data Change Request Items

Parameters

id string - id of the Data Change Request

payload DcrmanagerAddmassopidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DataChangeRequestMassChangeEnvelope|error - OK

massEditDataMartObject

Isolated FunctionRemote Function

function massEditDataMartObject(string typedId, MassEditRequest1 payload, map<string|string[]> headers) returns MassEditDatamartResponse|error

Mass Edit

Parameters

typedId string - The typedId of the object you want to perform the mass edit action for

payload MassEditRequest1 - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassEditDatamartResponse|error - OK - returns the number of edited records

massEditImports

Isolated FunctionRemote Function

function massEditImports(string typedId, ImportmanagerMassedittypedIdBody payload, map<string|string[]> headers) returns MassEditImportsEnvelope|error

Mass Edit Imports

Parameters

typedId string - The typedId to be sent with the request

payload ImportmanagerMassedittypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassEditImportsEnvelope|error - OK

massEditLookupTable

Isolated FunctionRemote Function

function massEditLookupTable(string tableId, MassEditRequest payload, map<string|string[]> headers) returns MassEditResponse|error

Mass Edit

Parameters

tableId string - The ID of the Lookup Table whose values you want to update

payload MassEditRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassEditResponse|error - OK - The response contains the number of modifed objects

massEditManualPriceListItems

Isolated FunctionRemote Function

function massEditManualPriceListItems(string id, MassEditMPLRequest payload, map<string|string[]> headers) returns MassEditManualPriceListResponse|error

Mass Edit a Manual Price List Items

Parameters

id string - The ID of the Manual Price List whose products you want to update

payload MassEditMPLRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassEditManualPriceListResponse|error - OK

massEditPriceGridItems

Isolated FunctionRemote Function

function massEditPriceGridItems(string id, MassEditPriceGridItemsRequest payload, map<string|string[]> headers) returns MassEditPriceGridItemsResponse|error

Mass Edit Price Grid Items

Parameters

id string - The id of the Live Price Grid whose items you want to edit. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

payload MassEditPriceGridItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassEditPriceGridItemsResponse|error - OK - The response contains "data":null as the mass edit task is a background process whose results are not yet available within the response time

massSubmitRebateRecordGroupItems

Isolated FunctionRemote Function

function massSubmitRebateRecordGroupItems(string typedId, RebaterecordgroupMasssubmittypedIdBody payload, map<string|string[]> headers) returns MassSubmitRRGResponse|error

Mass Submit Rebate Record Groups

Parameters

typedId string - The typedId to be sent with the request

payload RebaterecordgroupMasssubmittypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassSubmitRRGResponse|error - OK

massSubmitRebateRecordGroups

Isolated FunctionRemote Function

function massSubmitRebateRecordGroups(RebaterecordgroupMasssubmittypedIdBody payload, map<string|string[]> headers) returns MassSubmitRebateRecordGroupsEnvelope|error

Mass Submit Rebate Record Groups

Parameters

payload RebaterecordgroupMasssubmittypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassSubmitRebateRecordGroupsEnvelope|error - OK

massUpdate

Isolated FunctionRemote Function

function massUpdate(string typeCode, MassUpdateRequest payload, map<string|string[]> headers) returns MassUpdateResponse|error

Mass Update

Parameters

typeCode string - The object's type code. See the list of Type Codes

payload MassUpdateRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MassUpdateResponse|error - OK

performMassAction

Isolated FunctionRemote Function

function performMassAction(string id, PerformMassActionRequest payload, map<string|string[]> headers) returns PerformMassActionResponse|error

Perform a Mass Action

Parameters

id string - The ID of the Price Grid that contains items you want to apply workflow actions to

payload PerformMassActionRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PerformMassActionResponse|error - OK

pingWithout

Isolated FunctionRemote Function

function pingWithout(map<string|string[]> headers) returns Response|error

Ping (without authentication)

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - OK - Partition is exists

previewCustomFormWorkflow

Isolated FunctionRemote Function

function previewCustomFormWorkflow(record {} payload, map<string|string[]> headers) returns PreviewCustomFormWorkflowResponse|error

Preview a Custom Form Workflow

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PreviewCustomFormWorkflowResponse|error - OK

previewRebateRecordGroupWorkflow

Isolated FunctionRemote Function

function previewRebateRecordGroupWorkflow(string typedId, RebaterecordgroupPreviewtypedIdBody payload, map<string|string[]> headers) returns RebateRecordGroupWorkflowEnvelope|error

Preview a Rebate Record Group Workflow

Parameters

typedId string - The typedId to be sent with the request

payload RebaterecordgroupPreviewtypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RebateRecordGroupWorkflowEnvelope|error - OK

queryApiExecute

Isolated FunctionRemote Function

function queryApiExecute(QueryapiExecuteBody payload, map<string|string[]> headers, *QueryApiExecuteQueries queries) returns QueryApiExecuteEnvelope|error

Query API Execute

Parameters

payload QueryapiExecuteBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *QueryApiExecuteQueries - Queries to be sent with the request

Return Type

QueryApiExecuteEnvelope|error - Successful execution

queryDataManagerObject

Isolated FunctionRemote Function

function queryDataManagerObject(QueryDataManagerObjectRequest payload, map<string|string[]> headers, *QueryDataManagerObjectQueries queries) returns QueryDataManagerObjectResponse|error

Query a Data Manager Object

Parameters

payload QueryDataManagerObjectRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *QueryDataManagerObjectQueries - Queries to be sent with the request

Return Type

QueryDataManagerObjectResponse|error - OK

recalculateCalculationOfStep

Isolated FunctionRemote Function

function recalculateCalculationOfStep(string typedId, "definition"|"configuration"|"results"|"projections"|"parallel"  stepName, string calcName, record {} payload, map<string|string[]> headers) returns RecalculateCalculationOfStepResponse|error

Recalculate a Calculation of a Step

Parameters

typedId string - The typedId of the Model Object you want to recalculate the step for

stepName "definition"|"configuration"|"results"|"projections"|"parallel" - Enter the name of the step you want to calculate

calcName string - The name of the calculation you want to recalculate

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RecalculateCalculationOfStepResponse|error - OK

recalculateItemsOfParallelCalculation

Isolated FunctionRemote Function

function recalculateItemsOfParallelCalculation(string typedId, "definition"|"configuration"|"results"|"projections"|"parallel"  stepName, string calcName, CalcNameItemBody payload, map<string|string[]> headers) returns ParallelCalculationEnvelope|error

Recalculate Items of a Parallel Calculation

Parameters

typedId string - The typedId of the Model Object you want to recalculate the step for

stepName "definition"|"configuration"|"results"|"projections"|"parallel" - Enter the name of the step you want to calculate

calcName string - The name of the calculation you want to recalculate

payload CalcNameItemBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ParallelCalculationEnvelope|error - OK

recalculateQuote

Isolated FunctionRemote Function

function recalculateQuote(RecalculateQuoteRequest payload, map<string|string[]> headers) returns QuoteResponse|error

Recalculate a Quote

Parameters

payload RecalculateQuoteRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

recalculateQuoteContractRebate

Isolated FunctionRemote Function

function recalculateQuoteContractRebate(string typedId, map<string|string[]> headers, *RecalculateQuoteContractRebateQueries queries) returns RecalculateClicEnvelope|error

Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan

Parameters

typedId string - The typedId of the document you want to calculate

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *RecalculateQuoteContractRebateQueries - Queries to be sent with the request

Return Type

RecalculateClicEnvelope|error - OK

rejectCalculationGridItem

Isolated FunctionRemote Function

function rejectCalculationGridItem(string id, DenyCalculationGridItemRequest payload, map<string|string[]> headers) returns DenyCalculationGridItemResponse|error

Deny a Calculation Grid Item

Parameters

id string - The id of the Calculation Grid you want to deny items for. You can retrieve the id of the CG, for example, by calling the /fetch/CG endpoint

payload DenyCalculationGridItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DenyCalculationGridItemResponse|error - OK

rejectItems

Isolated FunctionRemote Function

function rejectItems(string typedId, RejectClaimItemsRequest payload, map<string|string[]> headers) returns RejectClaimItemsResponse|error

Reject Items

Parameters

typedId string - The typedId of the Claim whose items you want to reject

payload RejectClaimItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RejectClaimItemsResponse|error - OK

removeAllClicLineItems

Isolated FunctionRemote Function

function removeAllClicLineItems(string typedId, record {} payload, map<string|string[]> headers) returns ClicOperationEnvelope|error

Delete All Line Items

Parameters

typedId string - typedId of the object you want to remove all line items from

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ClicOperationEnvelope|error - OK

removeItems

Isolated FunctionRemote Function

function removeItems(string typedId, record {} payload, map<string|string[]> headers) returns RemoveClaimItemsResponse|error

Remove Items

Parameters

typedId string - The typedId of the Claim whose items you want to remove

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RemoveClaimItemsResponse|error - OK

replyToComment

Isolated FunctionRemote Function

function replyToComment(CommentmanagerReplyBody payload, map<string|string[]> headers) returns CommentOperationEnvelope|error

Reply To a Comment

Parameters

payload CommentmanagerReplyBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CommentOperationEnvelope|error - OK

resolveComment

Isolated FunctionRemote Function

function resolveComment(string typedId, record {} payload, map<string|string[]> headers) returns ResolveCommentEnvelope|error

Resolve a Comment

Parameters

typedId string - The typedId of the comment thread

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ResolveCommentEnvelope|error - OK

restoreDefaultDataSources

Isolated FunctionRemote Function

function restoreDefaultDataSources("Product"|"Customer"|"uom"|"ccy"|"cal"  dataSourceName, map<string|string[]> headers) returns RestoreDefaultDataSourcesResponse|error

Restore Default Data Sources

Parameters

dataSourceName "Product"|"Customer"|"uom"|"ccy"|"cal" - The name of the Data Source you want to create.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RestoreDefaultDataSourcesResponse|error - OK

revokeCompensationRecord

Isolated FunctionRemote Function

function revokeCompensationRecord(string typedId, map<string|string[]> headers) returns GenericDataResponse|error

Revoke a Compensation Record

Parameters

typedId string - typedId of the Compensation Record you want to revoke

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

revokeModel

Isolated FunctionRemote Function

function revokeModel(string typedId, record {} payload, map<string|string[]> headers) returns RevokeModelResponse|error

Revoke a Model

Parameters

typedId string - typedId of the model you want to revoke

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RevokeModelResponse|error - OK

revokePriceList

Isolated FunctionRemote Function

function revokePriceList(string id, PricelistmanagerSubmitidBody payload, map<string|string[]> headers) returns PriceListItemResponse|error

Revoke a Price List

Parameters

id string - The id to be sent with the request

payload PricelistmanagerSubmitidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceListItemResponse|error - Example response

revokeQuote

Isolated FunctionRemote Function

function revokeQuote(string identifier, map<string|string[]> headers) returns RevokeDealResponse|error

Revoke a Deal

Parameters

identifier string - Can be either the uniqueName or the typedId

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RevokeDealResponse|error - OK

revokeRebateRecordGroup

Isolated FunctionRemote Function

function revokeRebateRecordGroup(string typedId, map<string|string[]> headers) returns RevokeRebateRecordGroupEnvelope|error

Revoke a Rebate Record Group

Parameters

typedId string - typedId of the Rebate Record Group you want to revoke

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RevokeRebateRecordGroupEnvelope|error - OK

runCalculation

Isolated FunctionRemote Function

function runCalculation(RunCalculationRequest payload, map<string|string[]> headers) returns RunCalculationResponse|error

Run a Calculation

Parameters

payload RunCalculationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RunCalculationResponse|error - OK

runDataLoad

Isolated FunctionRemote Function

function runDataLoad(RunDataLoadRequest payload, map<string|string[]> headers) returns RunDataLoadResponse|error

Run a Data Load

Parameters

payload RunDataLoadRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RunDataLoadResponse|error - OK

runRebateCalculation

Isolated FunctionRemote Function

function runRebateCalculation(RebaterecordCalculatesetBody payload, map<string|string[]> headers) returns RunRebateCalculationResponse|error

Run a Rebate Calculation

Parameters

payload RebaterecordCalculatesetBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RunRebateCalculationResponse|error - OK

saveCalculation

Isolated FunctionRemote Function

function saveCalculation(SaveCalculationRequest payload, map<string|string[]> headers) returns SaveCalculationResponse|error

Save Calculation

Parameters

payload SaveCalculationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SaveCalculationResponse|error - OK

saveClicDraft

Isolated FunctionRemote Function

function saveClicDraft(string typedId, record {} payload, map<string|string[]> headers) returns ClicOperationEnvelope|error

Save a Temporary Data

Parameters

typedId string - typedId of the Temporary Quote you want to save

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ClicOperationEnvelope|error - OK

saveCompensationRecord

Isolated FunctionRemote Function

function saveCompensationRecord(SaveCompensationRecordRequest payload, map<string|string[]> headers) returns SaveCompensationRecordResponse|error

Save a Compensation Record

Parameters

payload SaveCompensationRecordRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SaveCompensationRecordResponse|error - OK

saveDataLoad

Isolated FunctionRemote Function

function saveDataLoad(DatamartUpdatedataloadBody payload, map<string|string[]> headers) returns DataLoadEnvelope|error

Save a Data Load

Parameters

payload DatamartUpdatedataloadBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DataLoadEnvelope|error - OK

saveImportChange

Isolated FunctionRemote Function

function saveImportChange(record {} payload, map<string|string[]> headers) returns SaveImportChangeEnvelope|error

Save Import Change

Parameters

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SaveImportChangeEnvelope|error - OK

saveModel

Isolated FunctionRemote Function

function saveModel(string typedId, "definition"|"configuration"|"results"|"projections"  stepName, SaveModelRequest payload, map<string|string[]> headers) returns SaveModelResponse|error

Save a Model

Parameters

typedId string - The typedId of the Model Object you want to save

stepName "definition"|"configuration"|"results"|"projections" - Enter the name of the step you want to save. Steps are defined in the Model Class that is associated to the Model Object

payload SaveModelRequest - The data property can only contain the state field, all the rest fields will be ignored (and cannot be updated even with update/MO endpoint)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SaveModelResponse|error - OK. Returns the updated Model Object

saveRebateCalculation

Isolated FunctionRemote Function

function saveRebateCalculation(SaveRebateCalculationRequest payload, map<string|string[]> headers) returns SaveRebateCalculationResponse|error

Save a Rebate Calculation

Parameters

payload SaveRebateCalculationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SaveRebateCalculationResponse|error - OK

searchKvTable

Isolated FunctionRemote Function

function searchKvTable(string tableName, SearchKVTableRequest payload, map<string|string[]> headers) returns SearchKvTableEnvelope[]|error

Search a KV Table

Parameters

tableName string - A name of the table you want to search the pattern for

payload SearchKVTableRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SearchKvTableEnvelope[]|error - OK

searchProducts

Isolated FunctionRemote Function

function searchProducts(SearchProductRequest payload, map<string|string[]> headers) returns SearchProductResponse|error

Search a Product

Parameters

payload SearchProductRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SearchProductResponse|error - OK

searchProductsByQuery

Isolated FunctionRemote Function

function searchProductsByQuery(string query, map<string|string[]> headers) returns SearchProductURLResponse|error

Search a Product (URL)

Parameters

query string - The query to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SearchProductURLResponse|error - OK

sendDocumentToSign

Isolated FunctionRemote Function

function sendDocumentToSign(string typedId, CreateSignatureRequest payload, map<string|string[]> headers) returns CreateSignatureResponse|error

Send a Document to Sign

Parameters

typedId string - typedId of the Compensation whose data you want to send via the e-signature system

payload CreateSignatureRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CreateSignatureResponse|error - OK

sendEmail

Isolated FunctionRemote Function

function sendEmail(SendEmailRequest payload, map<string|string[]> headers) returns GenericDataResponse|error

Send an Email

Parameters

payload SendEmailRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

sendValidationMessage

Isolated FunctionRemote Function

function sendValidationMessage(NotificationSendBody payload, map<string|string[]> headers) returns GenericDataResponse|error

Send a Validation Message

Parameters

payload NotificationSendBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

setClicLostReason

Isolated FunctionRemote Function

function setClicLostReason(string typedId, MarkOfferLostWithReasonRequest payload, map<string|string[]> headers) returns SetClicLostReasonEnvelope|error

Mark an Offer as Lost (with reason)

Parameters

typedId string - typedId of the Quote you want set as lost

payload MarkOfferLostWithReasonRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SetClicLostReasonEnvelope|error - OK

setDefaultPricingLogic

Isolated FunctionRemote Function

function setDefaultPricingLogic(string uniqueName, map<string|string[]> headers) returns SetDefaultPricingLogicResponse|error

Set a Default Pricing Logic

Parameters

uniqueName string - The name (uniqueName) of the logic that will be set as default. Leave blank to clear the default pricing logic

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SetDefaultPricingLogicResponse|error - OK

setReviewAsDone

Isolated FunctionRemote Function

function setReviewAsDone(string typedId, record {} payload, map<string|string[]> headers) returns Response|error

Set a Review as Done

Parameters

typedId string - typedId of the object to mark as reviewed

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - Review successfully marked as done

shouldSubmitRrgAsynchronously

Isolated FunctionRemote Function

function shouldSubmitRrgAsynchronously(string typedId, record {} payload, map<string|string[]> headers) returns CheckFileExistsEnvelope|error

Should Submit a RRG Asynchronously

Parameters

typedId string - typedId of the Rebate Record Group you want to return the async threshold boolean for

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CheckFileExistsEnvelope|error - OK

sqlQueryDataManagerObject

Isolated FunctionRemote Function

function sqlQueryDataManagerObject(DatamartSqlqueryBody payload, map<string|string[]> headers, *SqlQueryDataManagerObjectQueries queries) returns QueryDataManagerObjectResponse|error

SQL Query a Data Manager Object

Parameters

payload DatamartSqlqueryBody - sources that SQL can use are query definitions. The sources become CTEs (Common Table Expression) in the final SQL. These are then used as a reference in the main query instead of referring to the actual tables directly. The request example compares the volume by month 2019 to 2020

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *SqlQueryDataManagerObjectQueries - Queries to be sent with the request

Return Type

QueryDataManagerObjectResponse|error - OK

submitChanges

Isolated FunctionRemote Function

function submitChanges(string typedId, ImportmanagerSubmittypedIdBody payload, map<string|string[]> headers) returns ImportManagerUploadEnvelope|error

Submit Changes

Parameters

typedId string - typedId of the import

payload ImportmanagerSubmittypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ImportManagerUploadEnvelope|error - OK

submitClaim

Isolated FunctionRemote Function

function submitClaim(string typedId, record {} payload, map<string|string[]> headers) returns SubmitClaimResponse|error

Submit a Claim

Parameters

typedId string - typedId of the Claim you want to submit

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmitClaimResponse|error - OK

submitClic

Isolated FunctionRemote Function

function submitClic(string typedId, SubmitQuoteContractRebateAgreementRequest payload, map<string|string[]> headers) returns SubmitQuoteContractRebateAgreementResponse|error

Submit a Quote/Contract/Rebate Agreement

Parameters

typedId string - The typedId of the Contract, Quote, or Rebate Agreement you want to submit

payload SubmitQuoteContractRebateAgreementRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmitQuoteContractRebateAgreementResponse|error - OK

submitContract

Isolated FunctionRemote Function

function submitContract(SubmitContractRequest payload, map<string|string[]> headers) returns ContractModelResponse|error

Submit a Contract

Parameters

payload SubmitContractRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ContractModelResponse|error - Example response

submitDataChangeRequest

Isolated FunctionRemote Function

function submitDataChangeRequest(string id, record {} payload, map<string|string[]> headers) returns SubmitDCRResponse|error

Submit a Data Change Request

Parameters

id string - id of the DCR to be submitted

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmitDCRResponse|error - OK

submitDataChangeRequestAsync

Isolated FunctionRemote Function

function submitDataChangeRequestAsync(string id, record {} payload, map<string|string[]> headers) returns SubmitDCRAsyncResponse|error

Submit a Data Change Request (async)

Parameters

id string - id of the DCR to be submitted

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmitDCRAsyncResponse|error - OK

submitModel

Isolated FunctionRemote Function

function submitModel(string typedId, record {} payload, map<string|string[]> headers) returns SaveModelResponse|error

Submit a Model

Parameters

typedId string - The typedId of the Model Object you want to submit

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SaveModelResponse|error - OK. Returns the Model Object

submitPriceList

Isolated FunctionRemote Function

function submitPriceList(string id, PricelistmanagerSubmitidBody payload, map<string|string[]> headers) returns PriceListItemResponse|error

Submit a Price List

Parameters

id string - The ID of the Price List you want to submit. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

payload PricelistmanagerSubmitidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceListItemResponse|error - Example response

submitProducts

Isolated FunctionRemote Function

function submitProducts(string id, SubmitProductsRequest payload, map<string|string[]> headers) returns SubmitProductsResponse|error

Submit Products

Parameters

id string - The id of the Live Price Grid you want to submit items for. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

payload SubmitProductsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmitProductsResponse|error - OK - In case that more than one item is passed in the request, the body will not contain any data ("data":null). For a single item, the new PriceGridItem object is returned

submitQuote

Isolated FunctionRemote Function

function submitQuote(SubmitQuoteRequest payload, map<string|string[]> headers) returns QuoteResponse|error

Submit a Quote

Parameters

payload SubmitQuoteRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

submitRebateRecordGroup

Isolated FunctionRemote Function

function submitRebateRecordGroup(string typedId, record {} payload, map<string|string[]> headers) returns SubmitRebateRecordGroup|error

Submit a Rebate Record Group

Parameters

typedId string - typedId of the Rebate Record Group you want to submit

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmitRebateRecordGroup|error - OK

syntaxCheck

Isolated FunctionRemote Function

function syntaxCheck(SyntaxCheckRequest payload, map<string|string[]> headers) returns error?

Syntax Check

Parameters

payload SyntaxCheckRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

testLogic

Isolated FunctionRemote Function

function testLogic(TestLogicRequest payload, map<string|string[]> headers) returns TestLogicEnvelope|error

Test a Logic

Parameters

payload TestLogicRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

TestLogicEnvelope|error - OK

truncateTable

Isolated FunctionRemote Function

function truncateTable(string tableName, map<string|string[]> headers) returns TruncateKVTableResponse|error

Truncate a Table

Parameters

tableName string - The table you want to remove the keys from

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

TruncateKVTableResponse|error - OK

undoCompensationPlanRevocation

Isolated FunctionRemote Function

function undoCompensationPlanRevocation(string typedId, map<string|string[]> headers) returns error?

Undo Compensation Plan Revocation

Parameters

typedId string - The typedId to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

undoCompensationRecordRevocation

Isolated FunctionRemote Function

function undoCompensationRecordRevocation(string typedId, map<string|string[]> headers) returns error?

Undo Compensation Record Revocation

Parameters

typedId string - The typedId to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

undoRebateAgreementRevocation

Isolated FunctionRemote Function

function undoRebateAgreementRevocation(string typedId, map<string|string[]> headers) returns error?

Undo Rebate Agreement Revocation

Parameters

typedId string - The typedId to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

undoRebateRecordGroupRevocation

Isolated FunctionRemote Function

function undoRebateRecordGroupRevocation(string typedId, map<string|string[]> headers) returns error?

Undo Rebate Record Group Revocation

Parameters

typedId string - The typedId to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

undoRebateRecordRevocation

Isolated FunctionRemote Function

function undoRebateRecordRevocation(string typedId, map<string|string[]> headers) returns error?

Undo Rebate Record Revocation

Parameters

typedId string - The typedId to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

undoRevokeContract

Isolated FunctionRemote Function

function undoRevokeContract(string typedId, map<string|string[]> headers) returns error?

Undo Agreement & Promotion Revocation

Parameters

typedId string - The typedId to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

undoRevokeQuote

Isolated FunctionRemote Function

function undoRevokeQuote(string typedId, map<string|string[]> headers) returns error?

Undo Quote Revocation

Parameters

typedId string - The typedId to be sent with the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

unresolveComment

Isolated FunctionRemote Function

function unresolveComment(string typedId, record {} payload, map<string|string[]> headers) returns ResolveCommentEnvelope|error

Unresolve a Comment

Parameters

typedId string - The typedId of the comment thread

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ResolveCommentEnvelope|error - OK

updateActionItem

Isolated FunctionRemote Function

function updateActionItem(UpdateActionItemRequest payload, map<string|string[]> headers) returns UpdateActionItemResponse|error

Update an Action Item

Parameters

payload UpdateActionItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateActionItemResponse|error - OK

updateActionType

Isolated FunctionRemote Function

function updateActionType(UpdateAITBody payload, map<string|string[]> headers) returns UpdateActionTypeResponse|error

Update an Action Type

Parameters

payload UpdateAITBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateActionTypeResponse|error - OK

updateCalculationGrid

Isolated FunctionRemote Function

function updateCalculationGrid(UpdateCalculationGridRequest payload, map<string|string[]> headers) returns UpdateCalculationGridResponse|error

Update a Calculation Grid

Parameters

payload UpdateCalculationGridRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateCalculationGridResponse|error - OK

updateCalculationGridItem

Isolated FunctionRemote Function

function updateCalculationGridItem(string id, UpdateCalculationGridItemRequest payload, map<string|string[]> headers) returns UpdateCalculationGridItemResponse|error

Update a Calculation Grid Item

Parameters

id string - id of the Calculation Grid Item you want to update

payload UpdateCalculationGridItemRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateCalculationGridItemResponse|error - OK

updateClaim

Isolated FunctionRemote Function

function updateClaim(UpdateClaimRequest payload, map<string|string[]> headers) returns UpdateClaimResponse|error

Update a Claim

Parameters

payload UpdateClaimRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateClaimResponse|error - OK

updateClaimType

Isolated FunctionRemote Function

function updateClaimType(UpdateClaimTypeRequest payload, map<string|string[]> headers) returns UpdateClaimTypeResponse|error

Update a Claim Type

Parameters

payload UpdateClaimTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateClaimTypeResponse|error - OK

updateClicLineItems

Isolated FunctionRemote Function

function updateClicLineItems(string typedId, UpdateCLICLineItemsRequest payload, map<string|string[]> headers) returns UpdateClicLineItemsEnvelope|error

Update CLIC Line Items

Parameters

typedId string - typedId of the CLIC object (e.g., a Quote) you want to update line items for

payload UpdateCLICLineItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateClicLineItemsEnvelope|error - OK

updateCompensationRecord

Isolated FunctionRemote Function

function updateCompensationRecord(UpdateCompensationRecordRequest payload, map<string|string[]> headers) returns UpdateCompensationRecordResponse|error

Update a Compensation Record

Parameters

payload UpdateCompensationRecordRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateCompensationRecordResponse|error - OK

updateCompensationType

Isolated FunctionRemote Function

function updateCompensationType(UpdateCompensationTypeRequest payload, map<string|string[]> headers) returns UpdateCompensationTypeEnvelope|error

Update a Compensation Type

Parameters

payload UpdateCompensationTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateCompensationTypeEnvelope|error - OK

updateConditionRecordItemMeta

Isolated FunctionRemote Function

function updateConditionRecordItemMeta(UpdateCRCIMBody payload, map<string|string[]> headers) returns UpdateConditionRecordItemMetaEnvelope|error

Update a Condition Record Item Attribute Meta

Parameters

payload UpdateCRCIMBody -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateConditionRecordItemMetaEnvelope|error - OK

updateConditionRecordSet

Isolated FunctionRemote Function

function updateConditionRecordSet(string id, ConditionrecordsetUpdateidBody payload, map<string|string[]> headers) returns ConditionRecordSetOperationEnvelope|error

Update a Condition Record Set

Parameters

id string - id of the ConditionRecordSet object you want to update

payload ConditionrecordsetUpdateidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConditionRecordSetOperationEnvelope|error - OK

updateConditionType

Isolated FunctionRemote Function

function updateConditionType(UpdateConditionTypeRequest payload, map<string|string[]> headers) returns UpdateConditionTypeEnvelope|error

Update a Condition Type

Parameters

payload UpdateConditionTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateConditionTypeEnvelope|error - OK

updateConfigurationStorage

Isolated FunctionRemote Function

function updateConfigurationStorage(UpdateJCSBody payload, map<string|string[]> headers) returns ConfigurationStorageOperationEnvelope|error

Update a Configuration Storage

Parameters

payload UpdateJCSBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ConfigurationStorageOperationEnvelope|error - OK

updateCustomForm

Isolated FunctionRemote Function

function updateCustomForm(UpdateCustomFormRequest payload, map<string|string[]> headers) returns UpdateCustomFormEnvelope|error

Update a Custom Form

Parameters

payload UpdateCustomFormRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateCustomFormEnvelope|error - The Custom Form was updated successfully. The response includes the updated data

updateCustomFormType

Isolated FunctionRemote Function

function updateCustomFormType(UpdateCustomFormTypeRequest payload, map<string|string[]> headers) returns UpdateCustomFormTypeResponse|error

Update a Custom Form Type

Parameters

payload UpdateCustomFormTypeRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateCustomFormTypeResponse|error - OK

updateCustomer

Isolated FunctionRemote Function

function updateCustomer(UpdateCustomerRequest payload, map<string|string[]> headers) returns CustomerResponse|error

Update a Customer

Parameters

payload UpdateCustomerRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomerResponse|error - Returns customer record details

updateDataChangeRequestItem

Isolated FunctionRemote Function

function updateDataChangeRequestItem(string id, UpdateDCRIRequest payload, map<string|string[]> headers) returns UpdateDCRIResponse|error

Update a Data Change Request Item

Parameters

id string - id of the Data Change Request whose item you want to update

payload UpdateDCRIRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateDCRIResponse|error - OK

updateDataChangeRequestMassChanges

Isolated FunctionRemote Function

function updateDataChangeRequestMassChanges(string id, DcrmanagerUpdatemassopidBody payload, map<string|string[]> headers) returns DataChangeRequestMassChangeEnvelope|error

Update Data Change Request Mass Changes

Parameters

id string - id of the Data Change Request

payload DcrmanagerUpdatemassopidBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DataChangeRequestMassChangeEnvelope|error - OK

updateDataManagerEntity

Isolated FunctionRemote Function

function updateDataManagerEntity("DMF"|"DM"|"DMDS"  typeCode, UpdateDataManagerEntityRequest payload, map<string|string[]> headers) returns DmObjectResponse|error

Update a Data Manager Entity

Parameters

typeCode "DMF"|"DM"|"DMDS" - The type code of the Field Collection you want to update

payload UpdateDataManagerEntityRequest - Either uniqueName or typedId must be provided in the request

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DmObjectResponse|error - Example response

updateFile

Isolated FunctionRemote Function

function updateFile(string typedId, BdmanagerUpdatetypedIdBody payload, map<string|string[]> headers) returns UpdateFileEnvelope|error

Update a File

Parameters

typedId string - typedId of the document whose attachment's metadata you want to update

payload BdmanagerUpdatetypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateFileEnvelope|error - OK

updateJobStatusTrackerEntry

Isolated FunctionRemote Function

function updateJobStatusTrackerEntry(OptimizationUpdatejstBody payload, map<string|string[]> headers) returns JobStatusTrackerUpdateEnvelope|error

Update Job Status Tracker Entry

Parameters

payload OptimizationUpdatejstBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobStatusTrackerUpdateEnvelope|error - JST updated

updateLivePriceGridItem

Isolated FunctionRemote Function

function updateLivePriceGridItem(string id, UpdateLivePriceGridItemRequest payload, map<string|string[]> headers) returns PriceGridItemResponse|error

Update a Live Price Grid Item

Parameters

id string - The ID of the Price Grid whose item you want to update. id is the typedId without PG suffix. For example, the id attribute of the item with typedId = 649.PG is 649. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

payload UpdateLivePriceGridItemRequest - We have performed an update action on the comments field in our request sample >>>

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceGridItemResponse|error - Example response

updateLivePriceGridItemNo

Isolated FunctionRemote Function

function updateLivePriceGridItemNo(string id, UpdateLivePriceGridItemNoRecalcRequest payload, map<string|string[]> headers) returns PriceGridItemResponse|error

Update a Live Price Grid Item (No Recalculation)

Parameters

id string - The ID of the Price Grid whose item you want to update. id is the typedId without PG suffix. For example, the id attribute of the item with typedId = 649.PG is 649. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint

payload UpdateLivePriceGridItemNoRecalcRequest - We have performed an update action on the comments field in our request sample >>>

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceGridItemResponse|error - Example response

updateLivePriceGridType

Isolated FunctionRemote Function

function updateLivePriceGridType(UpdatePGTTBody payload, map<string|string[]> headers) returns LivePriceGridTypeOperationEnvelope|error

Update a Live Price Grid Type

Parameters

payload UpdatePGTTBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LivePriceGridTypeOperationEnvelope|error - OK

updateLogic

Isolated FunctionRemote Function

function updateLogic(string id, record { data record { version decimal, typedId string, uniqueName string, label string, validAfter string, status string, simulationSet anydata, userGroupEdit anydata, userGroupViewDetails anydata, formulaNature anydata, lastUpdateByName string, elements record { version decimal, typedId string, elementName string, elementLabel string, elementDescription anydata, elementGroups string[], conditionElementName anydata, hideWarnings boolean, excludeFromExport boolean, protectedExpression boolean, elementTimeout decimal, displayOptions decimal, formatType string?, elementSuffix anydata, allowOverride boolean, summarize boolean, hideOnNull boolean, userGroup anydata, cssProperties anydata, resultGroup anydata, combinationType string, storeInAttributeExtension boolean, criticalAlert anydata, redAlert anydata, yellowAlert anydata, labelTranslations anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal, formulaExpression string }[], inputDescriptors record {}[], formulaType string, createdByName anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal } } payload, map<string|string[]> headers) returns LogicResponse|error

Update a Logic

Parameters

id string - The ID of the logic. The id is the typedId without the F suffix. For example, the id attribute of the item with typedId = 2147484837.F is 2147484837

payload record { data record { version decimal, typedId string, uniqueName string, label string, validAfter string, status string, simulationSet anydata, userGroupEdit anydata, userGroupViewDetails anydata, formulaNature anydata, lastUpdateByName string, elements record { version decimal, typedId string, elementName string, elementLabel string, elementDescription anydata, elementGroups string[], conditionElementName anydata, hideWarnings boolean, excludeFromExport boolean, protectedExpression boolean, elementTimeout decimal, displayOptions decimal, formatType string?, elementSuffix anydata, allowOverride boolean, summarize boolean, hideOnNull boolean, userGroup anydata, cssProperties anydata, resultGroup anydata, combinationType string, storeInAttributeExtension boolean, criticalAlert anydata, redAlert anydata, yellowAlert anydata, labelTranslations anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal, formulaExpression string }[], inputDescriptors record {}[], formulaType string, createdByName anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal } } - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LogicResponse|error - Example response

updateLogicNo

Isolated FunctionRemote Function

function updateLogicNo(string id, record { data record { version decimal, typedId string, uniqueName string, label string, validAfter string, status string, simulationSet anydata, userGroupEdit anydata, userGroupViewDetails anydata, formulaNature anydata, lastUpdateByName string, elements record { version decimal, typedId string, elementName string, elementLabel string, elementDescription anydata, elementGroups string[], conditionElementName anydata, hideWarnings boolean, excludeFromExport boolean, protectedExpression boolean, elementTimeout decimal, displayOptions decimal, formatType string?, elementSuffix anydata, allowOverride boolean, summarize boolean, hideOnNull boolean, userGroup anydata, cssProperties anydata, resultGroup anydata, combinationType string, storeInAttributeExtension boolean, criticalAlert anydata, redAlert anydata, yellowAlert anydata, labelTranslations anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal, formulaExpression string }[], inputDescriptors record {}[], formulaType string, createdByName anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal } } payload, map<string|string[]> headers) returns LogicResponse|error

Update a Logic (No syntax check)

Parameters

id string - The ID of the logic. The id is the typedId without the F suffix. For example, the id attribute of the item with typedId = 2147484837.F is 2147484837

payload record { data record { version decimal, typedId string, uniqueName string, label string, validAfter string, status string, simulationSet anydata, userGroupEdit anydata, userGroupViewDetails anydata, formulaNature anydata, lastUpdateByName string, elements record { version decimal, typedId string, elementName string, elementLabel string, elementDescription anydata, elementGroups string[], conditionElementName anydata, hideWarnings boolean, excludeFromExport boolean, protectedExpression boolean, elementTimeout decimal, displayOptions decimal, formatType string?, elementSuffix anydata, allowOverride boolean, summarize boolean, hideOnNull boolean, userGroup anydata, cssProperties anydata, resultGroup anydata, combinationType string, storeInAttributeExtension boolean, criticalAlert anydata, redAlert anydata, yellowAlert anydata, labelTranslations anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal, formulaExpression string }[], inputDescriptors record {}[], formulaType string, createdByName anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal } } - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LogicResponse|error - Example response

updateLogicPartial

Isolated FunctionRemote Function

function updateLogicPartial(string id, record { data record { version decimal, typedId string, uniqueName string, label string, validAfter string, status string, simulationSet anydata, userGroupEdit anydata, userGroupViewDetails anydata, formulaNature anydata, lastUpdateByName string, elements record { version decimal, typedId string, elementName string, elementLabel string, elementDescription anydata, elementGroups string[], conditionElementName anydata, hideWarnings boolean, excludeFromExport boolean, protectedExpression boolean, elementTimeout decimal, displayOptions decimal, formatType string?, elementSuffix anydata, allowOverride boolean, summarize boolean, hideOnNull boolean, userGroup anydata, cssProperties anydata, resultGroup anydata, combinationType string, storeInAttributeExtension boolean, criticalAlert anydata, redAlert anydata, yellowAlert anydata, labelTranslations anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal, formulaExpression string }[], inputDescriptors record {}[], formulaType string, createdByName anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal } } payload, map<string|string[]> headers) returns LogicResponse|error

Update a Logic (Partial)

Parameters

id string - The ID of the logic. The id is the typedId without the F suffix. For example, the id attribute of the item with typedId = 2147484837.F is 2147484837

payload record { data record { version decimal, typedId string, uniqueName string, label string, validAfter string, status string, simulationSet anydata, userGroupEdit anydata, userGroupViewDetails anydata, formulaNature anydata, lastUpdateByName string, elements record { version decimal, typedId string, elementName string, elementLabel string, elementDescription anydata, elementGroups string[], conditionElementName anydata, hideWarnings boolean, excludeFromExport boolean, protectedExpression boolean, elementTimeout decimal, displayOptions decimal, formatType string?, elementSuffix anydata, allowOverride boolean, summarize boolean, hideOnNull boolean, userGroup anydata, cssProperties anydata, resultGroup anydata, combinationType string, storeInAttributeExtension boolean, criticalAlert anydata, redAlert anydata, yellowAlert anydata, labelTranslations anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal, formulaExpression string }[], inputDescriptors record {}[], formulaType string, createdByName anydata, createDate string, createdBy decimal, lastUpdateDate string, lastUpdateBy decimal } } - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

LogicResponse|error - Example response

updateLookupTable

Isolated FunctionRemote Function

function updateLookupTable(UpdateLookupTableRequest payload, map<string|string[]> headers) returns UpdateLookupTableResponse|error

Update a Lookup Table

Parameters

payload UpdateLookupTableRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateLookupTableResponse|error - OK

updateLookupTableValue

Isolated FunctionRemote Function

function updateLookupTableValue(string tableId, UpdateLookupTableValueRequest payload, map<string|string[]> headers) returns UpdateLookupTableValueResponse|error

Update a Lookup Table Value

Parameters

tableId string - Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method

payload UpdateLookupTableValueRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateLookupTableValueResponse|error - OK

updateManualPriceListItem

Isolated FunctionRemote Function

function updateManualPriceListItem(string id, UpdateManualPriceListRequest payload, map<string|string[]> headers) returns UpdateManualPriceListResponse|error

Update a Manual Price List Item

Parameters

id string - The ID of the Manual Price List whose item you want to update

payload UpdateManualPriceListRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateManualPriceListResponse|error - OK

updateObject

Isolated FunctionRemote Function

function updateObject(string typeCode, UpdateObjectRequest payload, map<string|string[]> headers) returns error?

Update an Object

Parameters

typeCode string - The object's type code. See the list of Type Codes

payload UpdateObjectRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK - contains the updated object

updateObjectReturningOldData

Isolated FunctionRemote Function

function updateObjectReturningOldData(string typeCode, UpdateObjectReturnOldDataRequest payload, map<string|string[]> headers) returns error?

Update an Object (and return old data)

Parameters

typeCode string - The object's type code. See the list of Type Codes

payload UpdateObjectReturnOldDataRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK - contains the updated object and details of the previous version

updatePriceListDetail

Isolated FunctionRemote Function

function updatePriceListDetail(string id, UpdatePricelistDetailRequest payload, map<string|string[]> headers) returns UpdatePricelistDetailResponse|error

Update a Pricelist Detail

Parameters

id string - The ID of the Price List whose Item you want to update. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837

payload UpdatePricelistDetailRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdatePricelistDetailResponse|error - OK

updatePriceListType

Isolated FunctionRemote Function

function updatePriceListType(UpdatePLTTBody payload, map<string|string[]> headers) returns PriceListTypeOperationEnvelope|error

Update a Price List Type

Parameters

payload UpdatePLTTBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PriceListTypeOperationEnvelope|error - OK

updateProduct

Isolated FunctionRemote Function

function updateProduct(UpdateProductRequest payload, map<string|string[]> headers) returns ProductResponse|error

Update a Product

Parameters

payload UpdateProductRequest - Updates specified fields of the record. Only one record can be updated per request (unless batched).

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

updateQuoteContractRebateAgreement

Isolated FunctionRemote Function

function updateQuoteContractRebateAgreement(string typedId, ClicmanagerUpdatetypedIdBody payload, map<string|string[]> headers) returns UpdateClicEnvelope|error

Update a Quote/Contract/Rebate Agreement/Compensation Plan

Parameters

typedId string - The typedId of the Compensation Plan you want to update

payload ClicmanagerUpdatetypedIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateClicEnvelope|error - OK

updateReviewStatus

Isolated FunctionRemote Function

function updateReviewStatus(string typedId, record {} payload, map<string|string[]> headers) returns GenericDataResponse|error

Update a Review Status

Parameters

typedId string - typedId of the object to update

payload record {} - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

updateSeller

Isolated FunctionRemote Function

function updateSeller(UpdateSellerRequest payload, map<string|string[]> headers) returns UpdateSellerEnvelope|error

Update a Seller

Parameters

payload UpdateSellerRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateSellerEnvelope|error - OK

updateSellerExtension

Isolated FunctionRemote Function

function updateSellerExtension(UpdateSXBody payload, map<string|string[]> headers) returns UpdateSellerExtensionEnvelope|error

Update a Seller Extension

Parameters

payload UpdateSXBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateSellerExtensionEnvelope|error - OK

updateUser

Isolated FunctionRemote Function

function updateUser(UpdateUserRequest payload, map<string|string[]> headers) returns UserResponse|error

Update a User

Parameters

payload UpdateUserRequest - Specify the user by typedId and define the new value of the field you want to update in the data object

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UserResponse|error - Example response

updateWorkflowDelegation

Isolated FunctionRemote Function

function updateWorkflowDelegation(UpdateWorkflowDelegationRequest payload, map<string|string[]> headers) returns UpdateWorkflowDelegationResponse|error

Update a Workflow Delegation

Parameters

payload UpdateWorkflowDelegationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpdateWorkflowDelegationResponse|error - OK

uploadBulkDataToDataSource

Isolated FunctionRemote Function

function uploadBulkDataToDataSource(string datasourceUniqueName, UploadBulkDataToDataSourceRequest payload, map<string|string[]> headers) returns BulkDataUploadEnvelope|error

Upload a Bulk Data to Data Source

Parameters

datasourceUniqueName string - The unique name of the Data Source where you want to upload the data to. You can also use typedId or the source name

payload UploadBulkDataToDataSourceRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BulkDataUploadEnvelope|error - OK

uploadExcelToImportManager

Isolated FunctionRemote Function

function uploadExcelToImportManager("P"|"PX"  typeCode, string target, string slotId, TypeCodetargetBody payload, map<string|string[]> headers, *UploadExcelToImportManagerQueries queries) returns ImportManagerUploadEnvelope|error

Upload Excel to Import Manager

Parameters

typeCode "P"|"PX" - Target object type code

target string - Provides additional details about the target object, such as specifying a PX name if required

slotId string - ID of the Upload Slot

payload TypeCodetargetBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UploadExcelToImportManagerQueries - Queries to be sent with the request

Return Type

ImportManagerUploadEnvelope|error - File uploaded successfully

uploadFile

Isolated FunctionRemote Function

function uploadFile(string typedId, string slotId, TypedIdslotIdBody payload, map<string|string[]> headers) returns FileOperationEnvelope|error

Upload a File

Parameters

typedId string - typedId of the document you want to attach the file to

slotId string - The ID of the slot you want to use for the upload. retrieve the slot ID using the /uploadmanager.newuploadslot (Create an Upload Slot) endpoint

payload TypedIdslotIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

FileOperationEnvelope|error - OK

uploadFileToPxCxSx

Isolated FunctionRemote Function

function uploadFileToPxCxSx("PX"|"CX"|"SX"  typeCode, string target, string uploadSlotId, TargetuploadSlotIdBody payload, map<string|string[]> headers, *UploadFileToPxCxSxQueries queries) returns GenericDataResponse|error

Upload a File to PX/CX/SX

Parameters

typeCode "PX"|"CX"|"SX" - Type code of the table you want to upload the file to

target string - The name of the PX/CX/SX table

uploadSlotId string - id of the upload slot. Use the uploadslotmanager.newuploadslot endpoint to retrieve the id

payload TargetuploadSlotIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UploadFileToPxCxSxQueries - Queries to be sent with the request

Return Type

GenericDataResponse|error - A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null

uploadProductImage

Isolated FunctionRemote Function

function uploadProductImage(string slotId, string sku, TypedIdslotIdBody payload, map<string|string[]> headers) returns error?

Upload a File

Parameters

slotId string - Enter the ID of the slot you want to use for the upload

sku string - Enter the sku of the product you want to add the product image to

payload TypedIdslotIdBody - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - OK

upsertCompensationPlan

Isolated FunctionRemote Function

function upsertCompensationPlan(UpsertCompensationPlanRequest payload, map<string|string[]> headers) returns UpsertCompensationPlanResponse|error

Upsert a Compensation Plan

Parameters

payload UpsertCompensationPlanRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpsertCompensationPlanResponse|error - OK

upsertContract

Isolated FunctionRemote Function

function upsertContract(UpsertContractRequest payload, map<string|string[]> headers) returns ContractModelResponse|error

Upsert a Contract

Parameters

payload UpsertContractRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ContractModelResponse|error - Example response

upsertCustomer

Isolated FunctionRemote Function

function upsertCustomer(UpsertCustomerRequest payload, map<string|string[]> headers) returns CustomerResponse|error

Upsert a Customer

Parameters

payload UpsertCustomerRequest - If the customer does not exist yet, at least the customerId must be specified in the payload.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

CustomerResponse|error - Returns customer record details

upsertCustomerExtension

Isolated FunctionRemote Function

function upsertCustomerExtension(UpsertCustomerExtensionRequest payload, map<string|string[]> headers) returns UpsertCustomerExtensionResponse|error

Upsert a Customer Extension

Parameters

payload UpsertCustomerExtensionRequest - Please note: The data sent in your request might be different from our sample request schema. Custom fields (attribute1..attribute30) can be retrieved using the /fetch/CXAM operation

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpsertCustomerExtensionResponse|error - OK

upsertKey

Isolated FunctionRemote Function

function upsertKey(string tableName, UpsertKVKeyRequest payload, map<string|string[]> headers) returns UpsertKVKeyResponse|error

Upsert a Key

Parameters

tableName string - A name of the table you want to upsert the key into

payload UpsertKVKeyRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpsertKVKeyResponse|error - OK. Returns "data" : null when successfully inserted/updated

upsertLookupTableValue

Isolated FunctionRemote Function

function upsertLookupTableValue(string tableId, UpsertLookupTableValueRequest payload, map<string|string[]> headers) returns UpsertLookupTableValueResponse|error

Upsert a Lookup Table Value

Parameters

tableId string - Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method

payload UpsertLookupTableValueRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpsertLookupTableValueResponse|error - OK

upsertManualPriceListProduct

Isolated FunctionRemote Function

function upsertManualPriceListProduct(string id, UpsertProductManualPriceListRequest payload, map<string|string[]> headers) returns ProductResponse|error

Upsert a Product in a Manual Price List

Parameters

id string - The ID of the Manual Price List whose product you want to create or update

payload UpsertProductManualPriceListRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

upsertObject

Isolated FunctionRemote Function

function upsertObject("ACTT"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CLLI"|"CN"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DREG"|"DWT"|"ET"|"EVT"|"F"|"FE"|"FN"|"IDC"|"IE"|"ISH"|"JST"|"JLTV"|"JLTVM"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"P"|"PAM"|"PAPIJ"|"PBOME"|"PCOMP"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI"  typeCode, UpsertObjectRequest payload, map<string|string[]> headers) returns ProductResponse|error

Upsert an Object

Parameters

typeCode "ACTT"|"AP"|"APIK"|"BD"|"BPT"|"BR"|"C"|"CA"|"CAM"|"CDESC"|"CF"|"CFS"|"CFT"|"CH"|"CLLI"|"CN"|"CS"|"CT"|"CTAM"|"CTLI"|"CTMU"|"CTMUI"|"CTT"|"CTTAM"|"CTTREE"|"CW"|"CX"|"CXAM"|"DA"|"DB"|"DCR"|"DCRAM"|"DCRI"|"DCRL"|"DCRMC"|"DCRT"|"DE"|"DI"|"DM"|"DMDC"|"DMDL"|"DMDS"|"DMF"|"DMM"|"DMR"|"DMT"|"DREG"|"DWT"|"ET"|"EVT"|"F"|"FE"|"FN"|"IDC"|"IE"|"ISH"|"JST"|"JLTV"|"JLTVM"|"LAT"|"LT"|"LTT"|"LTV"|"M"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"|"MPL"|"MPLAM"|"MPLI"|"MPLIT"|"MPLT"|"MR"|"MRAM"|"MT"|"P"|"PAM"|"PAPIJ"|"PBOME"|"PCOMP"|"PCW"|"PDESC"|"PG"|"PGI"|"PGIM"|"PGT"|"PH"|"PL"|"PLI"|"PLIM"|"PLT"|"PR"|"PRAM"|"PREF"|"PT"|"PWH"|"PX"|"PXAM"|"PXREF"|"PYR"|"PYRAM"|"Q"|"QAM"|"QLI"|"QMU"|"QMUI"|"QT"|"QTT"|"QTTAM"|"R"|"RAT"|"RATM"|"RBA"|"RBAAM"|"RBALI"|"RBAT"|"RBT"|"RBTAM"|"RR"|"RRAM"|"RRS"|"RRSC"|"RT"|"SAT"|"SC"|"SCN"|"SCNAM"|"SCT"|"SIAM"|"SIM"|"SIMI"|"TFA"|"TODO"|"U"|"UG"|"US"|"W"|"WD"|"WF"|"WFE"|"XPGI"|"XPLI"|"XSIMI" - Enter the Type code of the entity you want to insert a data to. See the list of Type codes in the Pricefx Knowledge Base article

payload UpsertObjectRequest - The /integrate/P endpoint (Upsert a Product) is used in our example.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

upsertObjectReturningOldData

Isolated FunctionRemote Function

function upsertObjectReturningOldData(TypeCodeEnum typeCode, UpsertObjectReturnOldDataRequest payload, map<string|string[]> headers) returns UpsertObjectReturnOldDataResponse|error

Upsert an Object (and return old data)

Parameters

typeCode TypeCodeEnum - Specify the type code for the entity you want to work with. See the list of Type Codes in the Pricefx Knowledge Base article.'

payload UpsertObjectReturnOldDataRequest - The /integrate/P/returnolddata endpoint (upserts a product) is used in our example.

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UpsertObjectReturnOldDataResponse|error - OK

upsertProduct

Isolated FunctionRemote Function

function upsertProduct(UpsertProductRequest payload, map<string|string[]> headers) returns ProductResponse|error

Upsert a Product

Parameters

payload UpsertProductRequest - Either sku or typedId must be specified in order to update an existing product

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

upsertProductExtension

Isolated FunctionRemote Function

function upsertProductExtension(UpsertProductExtensionRequest payload, map<string|string[]> headers) returns ProductResponse|error

Upsert a Product Extension

Parameters

payload UpsertProductExtensionRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProductResponse|error - Returns full record details

upsertQuote

Isolated FunctionRemote Function

function upsertQuote(UpsertQuoteRequest payload, map<string|string[]> headers) returns QuoteResponse|error

Upsert a Quote

Parameters

payload UpsertQuoteRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

QuoteResponse|error - Example response

upsertRebateAgreement

Isolated FunctionRemote Function

function upsertRebateAgreement(UpsertRebateAgreementRequest payload, map<string|string[]> headers) returns RebateAgreementResponse|error

Upsert a Rebate Agreement

Parameters

payload UpsertRebateAgreementRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RebateAgreementResponse|error - Example response

validateItems

Isolated FunctionRemote Function

function validateItems(string typedId, ValidateClaimItemsRequest payload, map<string|string[]> headers) returns ValidateClaimItemsResponse|error

Validate Items

Parameters

typedId string - The typedId of the Claim whose items you want to validate

payload ValidateClaimItemsRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ValidateClaimItemsResponse|error - OK

validateWorkflowDelegation

Isolated FunctionRemote Function

function validateWorkflowDelegation(ValidateWorkflowDelegationRequest payload, map<string|string[]> headers) returns ValidateWorkflowDelegationResponse|error

Validate a Workflow Delegation

Parameters

payload ValidateWorkflowDelegationRequest - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ValidateWorkflowDelegationResponse|error - OK

withdrawDocument

Isolated FunctionRemote Function

function withdrawDocument(string currentStepId, map<string|string[]> headers) returns WithdrawDocumentResponse|error

Withdraw a Document

Parameters

currentStepId string - The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

WithdrawDocumentResponse|error - OK

Records

pricefx: BasicCredentials

Closed record

Your regular Pricefx login, which the connector turns into a reusable session token.

Pricefx charges a deliberate penalty on Basic authenticated requests - roughly 500ms, because "the password verification is intentionally slow to mitigate brute-force password guess attacks"

and hands back an X-PriceFx-jwt session token on the first such call. The connector therefore authenticates once when the client is created and uses that token for everything afterwards, so the penalty is paid once per client rather than on every request. When the token expires the connector obtains a new one and replays the request, so nothing is required of the caller.

Fields

username string - Your Pricefx username

password string - Your Pricefx password

partition string - The partition to authenticate against. Pricefx requires the Basic auth credential to be <partition>/<username>:<password>; the connector assembles that for you

pricefx: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth PricefxCredentials - How to authenticate. Pick the PricefxCredentials record matching the credentials you hold - the compiler will hold you to that choice

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

pricefx: ExternalJwtCredentials

Closed record

A JWT signed by a system Pricefx has been configured to trust.

Requires a trust relationship on the Pricefx side (an externalJWTConfiguration entry naming your system and holding its public key). The token is sent as Authorization: Bearer <systemName>;<jwt>, which is a Pricefx-specific value rather than a standard bearer token.

Fields

systemName string - The external system's name, as configured in externalJWTConfiguration

jwt string - A JWT signed by that system

pricefx: JwtCredentials

Closed record

A Pricefx-issued JWT you already hold.

Sent as-is via X-PriceFx-jwt. Nothing is exchanged, so creating the client performs no network call at all - the cheapest of the options here.

Intended for the non-expiring integration tokens produced by generateJwtToken (or the time-limited ones from generateTimedJwtToken), which you obtain once and keep in configuration. The connector cannot refresh a token supplied this way, as it holds no credentials to re-authenticate with: if the token is rejected the error surfaces to you rather than being retried. That is correct for a non-expiring token, but a short-lived session token pasted in here will eventually stop working - use BasicCredentials if you want renewal handled for you.

Fields

jwt string - The Pricefx-issued JWT to send on every request

pricefx: OAuth2Credentials

Closed record

OAuth 2.0, using a refresh token you obtained beforehand.

The initial authorization-code exchange needs an interactive browser redirect and so cannot be automated by this connector (or any library) - do it once out of band and keep the refresh token. From then on Ballerina's HTTP layer fetches an access token before the first request that needs one and silently renews it on expiry.

Fields

clientId string - The client identifier, as registered in Pricefx's oauthConfiguration

clientSecret? string - The client secret, if one was configured for this client

refreshToken string - A refresh token from a completed Authorization Code Grant flow

Union types

pricefx: PricefxCredentials

BasicCredentials|JwtCredentials|OAuth2Credentials|ExternalJwtCredentials

PricefxCredentials

How to authenticate with Pricefx. Pick the record matching the credentials you hold; the compiler then holds you to that choice, rather than accepting any mixture of loose optional fields.

Import

import ballerinax/pricefx;

Other versions

0.1.1

0.1.0

Metadata

Released date: 1 day ago

Version: 0.1.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes

Pull count

Total: 6

Current verison: 2

Weekly downloads

Source repository

Keywords

Name/Pricefx

Area/CRM & Sales

Vendor/Pricefx

Cost/Paid

Type/Connector

Pricefx

Pricing

CPQ

Contributors

Dependencies

ballerina/constraint/1.7.0 ballerina/os/1.10.1 ballerina/mime/2.12.2

Cookie policy

Delete policy

clients

records

unionTypes

ballerinax/pricefx Ballerina library

Overview

Setup guide

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

List all price lists

Step 4: Run the Ballerina application

Examples

Build from the source

Setting up the prerequisites

Build options

Contribute to Ballerina

Code of conduct

Useful links

Clients

pricefx: Client

Constructor

acceptCalculationGridItem

Parameters

Return Type

addActionType

Parameters

Return Type

addApproverStep

Parameters

Return Type

addCalculation

Parameters

Return Type

addCalculationGrid

Parameters

Return Type

addCalculationGridItem

Parameters

Return Type

addClaim

Parameters

Return Type

addClaimType

Parameters

Return Type

addComment

Parameters

Return Type

addCompensationType

Parameters

Return Type

addConditionRecordItemMeta

Parameters

Return Type

addConditionRecordSet

Parameters

Return Type

addConditionType

Parameters

Return Type

addConfigurationStorage

Parameters

Return Type

addContractLineItems

Parameters

Return Type

addCustomer

Parameters

Return Type

addDataChangeRequest

Parameters

Return Type

addDataChangeRequestItem

Parameters

Return Type

addLineItems

Parameters

Return Type

addLivePriceGridType