Actions

The ballerinax/pricefx package exposes the following clients:

Client	Purpose
Client	Provides access to the Pricefx Backend API for managing products, customers, sellers, price lists, calculation grids, quotes, contracts, rebate agreements, sales compensations, attachments, and more.

---

Client

Configuration

PricefxCredentials

PricefxCredentials is a union of four records - BasicCredentials, JwtCredentials, OAuth2Credentials, or ExternalJwtCredentials. Pick the one matching the credentials you hold and pass it as the auth field of ConnectionConfig.

BasicCredentials

Field	Type	Default	Description
username	string	Required	Your Pricefx username
password	string	Required	Your Pricefx password
partition	string	Required	Your Pricefx partition name

JwtCredentials

Field	Type	Default	Description
jwt	string	Required	A Pricefx-issued JWT you already hold, sent directly as the X-PriceFx-jwt header, with no exchange. Intended for the non-expiring integration tokens produced by generateJwtToken (or the time-limited ones from generateTimedJwtToken). Cannot be refreshed by the connector - a rejected token surfaces as an error rather than being retried, so avoid pasting in a short-lived session token here

OAuth2Credentials

Field	Type	Default	Description
clientId	string	Required	The client identifier, as registered in Pricefx's oauthConfiguration
clientSecret	string	Optional	The client secret, if one was configured for this client
refreshToken	string	Required	A refresh token from a completed Authorization Code Grant flow

ExternalJwtCredentials

Field	Type	Default	Description
systemName	string	Required	The external system's name, as configured in externalJWTConfiguration
jwt	string	Required	A JWT signed by that system

ConnectionConfig

Provides a set of configurations for controlling the behaviours when communicating with the Pricefx API.

Field	Type	Default	Description
auth	PricefxCredentials	Required	How to authenticate - one of the four PricefxCredentials records above
httpVersion	http:HttpVersion	http:HTTP_2_0	The HTTP version understood by the client
http1Settings	pricefx:ClientHttp1Settings	Optional	Configurations related to HTTP/1.x protocol
http2Settings	http:ClientHttp2Settings	Optional	Configurations related to HTTP/2 protocol
timeout	decimal	60	The maximum time to wait (in seconds) for a response before closing the connection
forwarded	string	"disable"	The choice of setting forwarded/x-forwarded header
poolConfig	http:PoolConfiguration	Optional	Configurations associated with request pooling
cache	http:CacheConfig	Optional	HTTP caching related configurations
compression	http:Compression	http:COMPRESSION_AUTO	Specifies the way of handling compression (accept-encoding) header
circuitBreaker	http:CircuitBreakerConfig	Optional	Configurations associated with the behaviour of the Circuit Breaker
retryConfig	http:RetryConfig	Optional	Configurations associated with retrying
responseLimits	http:ResponseLimitConfigs	Optional	Configurations associated with inbound response size limits
secureSocket	http:ClientSecureSocket	Optional	SSL/TLS-related options
proxy	http:ProxyConfig	Optional	Proxy server related options
validation	boolean	true	Enables the inbound payload validation functionality provided by the constraint package
laxDataBinding	boolean	true	Enables relaxed data binding on the client side, treating nil values and absent fields as optional

Initializing the client

import ballerinax/pricefx;

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

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

Operations

User Admin

addUser

Add a User

Parameters:

Name	Type	Required	Description
payload	pricefx:AddUserRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UserResponse|error

Sample code:

pricefx:UserResponse result = check pricefxClient->addUser(payload);

assignBusinessRole

Assign a Business Role

Parameters:

Name	Type	Required	Description
payload	pricefx:AssignBusinessRoleRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignBusinessRoleResponse|error

Sample code:

pricefx:AssignBusinessRoleResponse result = check pricefxClient->assignBusinessRole(payload);

assignBusinessRoleToUser

Assign a Business Role to a User

Parameters:

Name	Type	Required	Description
userId	string	Yes	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	pricefx:AssignBusinessRoleToUserRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignBusinessRoleToUserResponse|error

Sample code:

pricefx:AssignBusinessRoleToUserResponse result = check pricefxClient->assignBusinessRoleToUser(userId, payload);

assignGroupToBusinessRole

Assign a Group to a Business Role

Parameters:

Name	Type	Required	Description
payload	pricefx:AssignGroupToBusinessRoleRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignGroupToBusinessRoleResponse|error

Sample code:

pricefx:AssignGroupToBusinessRoleResponse result = check pricefxClient->assignGroupToBusinessRole(payload);

assignRoleToBusinessRole

Assign a Role to a Business Role

Parameters:

Name	Type	Required	Description
payload	pricefx:AssignRoleToBusinessRoleRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignRoleToBusinessRoleResponse|error

Sample code:

pricefx:AssignRoleToBusinessRoleResponse result = check pricefxClient->assignRoleToBusinessRole(payload);

assignRoleToUser

Assign a Role to a User

Parameters:

Name	Type	Required	Description
userId	string	Yes	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	pricefx:AssignRoleToUserRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignRoleToUserResponse|error

Sample code:

pricefx:AssignRoleToUserResponse result = check pricefxClient->assignRoleToUser(userId, payload);

assignRoleToUsers

Assign a Role to Users

Parameters:

Name	Type	Required	Description
payload	pricefx:AssignRoleToUsersRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignRoleToUsersResponse|error

Sample code:

pricefx:AssignRoleToUsersResponse result = check pricefxClient->assignRoleToUsers(payload);

assignUserGroupToUsers

Assign a User Group to Users

Parameters:

Name	Type	Required	Description
payload	pricefx:AssignUserGroupToUsersRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignUserGroupToUsersResponse|error

Sample code:

pricefx:AssignUserGroupToUsersResponse result = check pricefxClient->assignUserGroupToUsers(payload);

assignUserToUserGroup

Assign a User to a User Group

Parameters:

Name	Type	Required	Description
userId	string	Yes	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	pricefx:AssignUserToUserGroupRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignUserToUserGroupResponse|error

Sample code:

pricefx:AssignUserToUserGroupResponse result = check pricefxClient->assignUserToUserGroup(userId, payload);

changeCurrentUserPassword

Change a Current User Password

Parameters:

Name	Type	Required	Description
payload	pricefx:ChangeCurrentUserPasswordRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ChangeCurrentUserPasswordResponse|error

Sample code:

pricefx:ChangeCurrentUserPasswordResponse result = check pricefxClient->changeCurrentUserPassword(payload);

changeUserPassword

Change a User Password

Parameters:

Name	Type	Required	Description
userId	string	Yes	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	pricefx:ChangeUserPasswordRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ChangeUserPasswordResponse|error

Sample code:

pricefx:ChangeUserPasswordResponse result = check pricefxClient->changeUserPassword(userId, payload);

copyRoles

Copy Roles + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:CopyRolesRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CopyRolesResponse|error

Sample code:

pricefx:CopyRolesResponse result = check pricefxClient->copyRoles(payload);

copyUser

Copy a User

Parameters:

Name	Type	Required	Description
userid	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:CopyUserResponse|error

Sample code:

pricefx:CopyUserResponse result = check pricefxClient->copyUser(userid);

deleteBusinessRole

Delete a Business Role

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteBusinessRoleRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteBusinessRoleResponse|error

Sample code:

pricefx:DeleteBusinessRoleResponse result = check pricefxClient->deleteBusinessRole(payload);

deleteUser

Delete a User

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteUserRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UserResponse|error

Sample code:

pricefx:UserResponse result = check pricefxClient->deleteUser(payload);

deleteUserGroup

Delete a User Group

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteUserGroupRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteUserGroupResponse|error

Sample code:

pricefx:DeleteUserGroupResponse result = check pricefxClient->deleteUserGroup(payload);

generateJwtToken

Generate a JWT Token

Parameters:

Name	Type	Required	Description
payload	pricefx:GenerateJWTTokenRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenerateJWTTokenResponse|error

Sample code:

pricefx:GenerateJWTTokenResponse result = check pricefxClient->generateJwtToken(payload);

generateTimedJwtToken

Generate a JWT Token (time limited)

Parameters:

Name	Type	Required	Description
minutes	string	Yes	The number of minutes in which the token expires
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenerateJWTTokenTimeLimitedResponse|error

Sample code:

pricefx:GenerateJWTTokenTimeLimitedResponse result = check pricefxClient->generateTimedJwtToken(minutes);

getOneTimeToken

Get a One Time Token

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetOneTimeTokenResponse|error

Sample code:

pricefx:GetOneTimeTokenResponse result = check pricefxClient->getOneTimeToken();

getUserAuditReport

Get a User Audit Report

Parameters:

Name	Type	Required	Description
typeCode	"R"|"UG"|"BR"	Yes	Specify whether you want to retrieve a report based on user roles (R), user groups (UG), or business roles (BR)
id	string	Yes	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 {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UserAuditReportEnvelope|error

Sample code:

pricefx:UserAuditReportEnvelope result = check pricefxClient->getUserAuditReport(typeCode, id, payload);

listGroupsOfBusinessRole

List Groups of the Business Role

Parameters:

Name	Type	Required	Description
businessroleId	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:ListGroupsOfBusinessRoleResponse|error

Sample code:

pricefx:ListGroupsOfBusinessRoleResponse result = check pricefxClient->listGroupsOfBusinessRole(businessroleId);

listRolesOfBusinessRole

List Roles of the Business Role

Parameters:

Name	Type	Required	Description
businessroleId	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:ListRolesOfBusinessRoleResponse|error

Sample code:

pricefx:ListRolesOfBusinessRoleResponse result = check pricefxClient->listRolesOfBusinessRole(businessroleId);

listUserSBusinessRoles

List User's Business Roles

Parameters:

Name	Type	Required	Description
userId	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:ListUserBusinessRolesResponse|error

Sample code:

pricefx:ListUserBusinessRolesResponse result = check pricefxClient->listUserSBusinessRoles(userId);

listUserSRoles

List User's Roles

Parameters:

Name	Type	Required	Description
userId	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:ListUserRolesResponse|error

Sample code:

pricefx:ListUserRolesResponse result = check pricefxClient->listUserSRoles(userId);

listUserSUserGroups

List User's User Groups

Parameters:

Name	Type	Required	Description
userId	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:ListUsersUserGroupsResponse|error

Sample code:

pricefx:ListUsersUserGroupsResponse result = check pricefxClient->listUserSUserGroups(userId);

listUsers

List Users

Parameters:

Name	Type	Required	Description
payload	pricefx:ListUsersRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListUsersResponse|error

Sample code:

pricefx:ListUsersResponse result = check pricefxClient->listUsers(payload);

updateUser

Update a User

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateUserRequest	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:UserResponse|error

Sample code:

pricefx:UserResponse result = check pricefxClient->updateUser(payload);

Products

addProduct

Add a Product

Parameters:

Name	Type	Required	Description
payload	pricefx:AddProductRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->addProduct(payload);

bulkInsertProducts

Insert Bulk Products

Parameters:

Name	Type	Required	Description
payload	pricefx:InsertBulkProductsRequest	Yes	Specify product field names in the header object and fields values in the data object.<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LoadDataResponse|error

Sample code:

pricefx:LoadDataResponse result = check pricefxClient->bulkInsertProducts(payload);

deleteProduct

Delete a Product

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteProductRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteProductResponse|error

Sample code:

pricefx:DeleteProductResponse result = check pricefxClient->deleteProduct(payload);

getProductBomTree

List BoM for a Product

Parameters:

Name	Type	Required	Description
sku	string	Yes	The sku of the product you want to retrieve the Bill of Materials for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListBoMForProductResponse|error

Sample code:

pricefx:ListBoMForProductResponse result = check pricefxClient->getProductBomTree(sku);

listProducts

List Products

Parameters:

Name	Type	Required	Description
payload	pricefx:ListProductsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->listProducts(payload);

listRecommendations

List Recommendations

Parameters:

Name	Type	Required	Description
payload	pricefx:ListRecommendationsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListRecommendationsEnvelope|error

Sample code:

pricefx:ListRecommendationsEnvelope result = check pricefxClient->listRecommendations(payload);

searchProducts

Search a Product

Parameters:

Name	Type	Required	Description
payload	pricefx:SearchProductRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SearchProductResponse|error

Sample code:

pricefx:SearchProductResponse result = check pricefxClient->searchProducts(payload);

searchProductsByQuery

Search a Product (URL)

Parameters:

Name	Type	Required	Description
query	string	Yes	The query to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SearchProductURLResponse|error

Sample code:

pricefx:SearchProductURLResponse result = check pricefxClient->searchProductsByQuery(query);

updateProduct

Update a Product

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateProductRequest	Yes	Updates specified fields of the record. Only one record can be updated per request (unless batched).<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->updateProduct(payload);

upsertProduct

Upsert a Product

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertProductRequest	Yes	Either sku or typedId must be specified in order to update an existing product
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->upsertProduct(payload);

Product Extensions

deleteProductExtension

Delete a Product Extension

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteProductExtensionRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteProductExtensionResponse|error

Sample code:

pricefx:DeleteProductExtensionResponse result = check pricefxClient->deleteProductExtension(payload);

getProductAttributeMeta

Get Product Attribute Meta

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductAttributeMetaEnvelope|error

Sample code:

pricefx:ProductAttributeMetaEnvelope result = check pricefxClient->getProductAttributeMeta(payload);

insertBulkProductExtensions

Insert Bulk Product Extensions

Parameters:

Name	Type	Required	Description
payload	pricefx:InsertBulkProductExtensionsRequest	Yes	Specify product extension field names in the header object and field values in the data object
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->insertBulkProductExtensions(payload);

listProductExtensionObjects

List Product Extension Objects

Parameters:

Name	Type	Required	Description
productMasterExtensionName	string	Yes	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	pricefx:ListProductExtensionObjectsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ListProductExtensionObjectsQueries	Yes	Queries to be sent with the request

Returns: pricefx:ProductExtensionResponse|error

Sample code:

pricefx:ProductExtensionResponse result = check pricefxClient->listProductExtensionObjects(productMasterExtensionName, payload, queries);

upsertProductExtension

Upsert a Product Extension

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertProductExtensionRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->upsertProductExtension(payload);

Product Image

deleteUploadSlotViaGet

3. Delete an Upload Slot

Parameters:

Name	Type	Required	Description
slotId	string	Yes	Enter the ID of the slot you want to delete
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteUploadSlotResponse|error

Sample code:

pricefx:DeleteUploadSlotResponse result = check pricefxClient->deleteUploadSlotViaGet(slotId);

getNewUploadSlot

1. Create an Upload Slot

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CreateUploadSlotResponse|error

Sample code:

pricefx:CreateUploadSlotResponse result = check pricefxClient->getNewUploadSlot();

uploadProductImage

2. Upload a File

Parameters:

Name	Type	Required	Description
slotId	string	Yes	Enter the ID of the slot you want to use for the upload
sku	string	Yes	Enter the sku of the product you want to add the product image to
payload	pricefx:TypedIdslotIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->uploadProductImage(slotId, sku, payload);

Competition Data

getProductCompetition

Get Competition Data

Parameters:

Name	Type	Required	Description
payload	pricefx:GetCompetitionDataRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetCompetitionDataResponse|error

Sample code:

pricefx:GetCompetitionDataResponse result = check pricefxClient->getProductCompetition(payload);

getProductSetCompetition

Get a Product Set

Parameters:

Name	Type	Required	Description
label	string	Yes	Enter the name of the product set you want to retrieve
payload	pricefx:GetProductSetRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetProductSetResponse|error

Sample code:

pricefx:GetProductSetResponse result = check pricefxClient->getProductSetCompetition(label, payload);

importProductCompetition

Import Competition Data

Parameters:

Name	Type	Required	Description
payload	pricefx:ImportCompetitionDataRequest	Yes	The competition product details
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ImportCompetitionDataResponse|error

Sample code:

pricefx:ImportCompetitionDataResponse result = check pricefxClient->importProductCompetition(payload);

listProductSets

List Product Sets

Parameters:

Name	Type	Required	Description
payload	pricefx:ListProductSetsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListProductSetsResponse|error

Sample code:

pricefx:ListProductSetsResponse result = check pricefxClient->listProductSets(payload);

Customers

addCustomer

Add a Customer

Parameters:

Name	Type	Required	Description
payload	pricefx:AddCustomerRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CustomerResponse|error

Sample code:

pricefx:CustomerResponse result = check pricefxClient->addCustomer(payload);

assignCustomers

Assign Customers

Parameters:

Name	Type	Required	Description
payload	pricefx:AssignCustomersRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignmentResponse|error

Sample code:

pricefx:AssignmentResponse result = check pricefxClient->assignCustomers(payload);

bulkInsertCustomers

Insert Bulk Customers

Parameters:

Name	Type	Required	Description
payload	pricefx:InsertBulkCustomersRequest	Yes	Specify customer field names in the header object and fields values in the data object.<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LoadDataResponse|error

Sample code:

pricefx:LoadDataResponse result = check pricefxClient->bulkInsertCustomers(payload);

deleteCustomer

Delete a Customer

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCustomerRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCustomerResponse|error

Sample code:

pricefx:DeleteCustomerResponse result = check pricefxClient->deleteCustomer(payload);

getCustomer

Get a Customer

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:CustomerResponse|error

Sample code:

pricefx:CustomerResponse result = check pricefxClient->getCustomer(id);

listCustomerAssignments

List Customer Assignments

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the entity you want to retrieve assignments for
payload	pricefx:ListCustomerAssignmentsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AssignmentResponse|error

Sample code:

pricefx:AssignmentResponse result = check pricefxClient->listCustomerAssignments(typedId, payload);

listCustomers

List Customers

Parameters:

Name	Type	Required	Description
payload	pricefx:ListCustomersRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CustomerResponse|error

Sample code:

pricefx:CustomerResponse result = check pricefxClient->listCustomers(payload);

updateCustomer

Update a Customer + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCustomerRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CustomerResponse|error

Sample code:

pricefx:CustomerResponse result = check pricefxClient->updateCustomer(payload);

upsertCustomer

Upsert a Customer

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertCustomerRequest	Yes	If the customer does not exist yet, at least the customerId must be specified in the payload.<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CustomerResponse|error

Sample code:

pricefx:CustomerResponse result = check pricefxClient->upsertCustomer(payload);

Customer Extensions

deleteCustomerExtension

Delete a Customer Extension

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCustomerExtensionRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCustomerExtensionResponse|error

Sample code:

pricefx:DeleteCustomerExtensionResponse result = check pricefxClient->deleteCustomerExtension(payload);

insertBulkCustomerExtensions

Insert Bulk Customer Extensions

Parameters:

Name	Type	Required	Description
payload	pricefx:InsertBulkCustomerExtensionsRequest	Yes	Specify customer extension field names in the header object and field values in the data object.<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LoadDataResponse|error

Sample code:

pricefx:LoadDataResponse result = check pricefxClient->insertBulkCustomerExtensions(payload);

listCustomerExtensionObjects

List Customer Extension Objects

Parameters:

Name	Type	Required	Description
customerMasterExtensionName	string	Yes	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	pricefx:ListCustomerExtensionObjectsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ListCustomerExtensionObjectsQueries	Yes	Queries to be sent with the request

Returns: pricefx:ListCustomerExtensionObjectsResponse|error

Sample code:

pricefx:ListCustomerExtensionObjectsResponse result = check pricefxClient->listCustomerExtensionObjects(customerMasterExtensionName, payload, queries);

uploadFileToPxCxSx

Upload a File to PX/CX/SX

Parameters:

Name	Type	Required	Description
typeCode	"PX"|"CX"|"SX"	Yes	Type code of the table you want to upload the file to
target	string	Yes	The name of the PX/CX/SX table
uploadSlotId	string	Yes	id of the upload slot. Use the uploadslotmanager.newuploadslot endpoint to retrieve the id
payload	pricefx:TargetuploadSlotIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:UploadFileToPxCxSxQueries	Yes	Queries to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->uploadFileToPxCxSx(typeCode, target, uploadSlotId, payload, queries);

upsertCustomerExtension

Upsert a Customer Extension

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertCustomerExtensionRequest	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:UpsertCustomerExtensionResponse|error

Sample code:

pricefx:UpsertCustomerExtensionResponse result = check pricefxClient->upsertCustomerExtension(payload);

Sellers

addSeller

Add a Seller

Parameters:

Name	Type	Required	Description
payload	pricefx:AddSellerRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddSellerEnvelope|error

Sample code:

pricefx:AddSellerEnvelope result = check pricefxClient->addSeller(payload);

deleteSeller

Delete a Seller

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteSellerRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteSellerEnvelope|error

Sample code:

pricefx:DeleteSellerEnvelope result = check pricefxClient->deleteSeller(payload);

listSellers

List Sellers

Parameters:

Name	Type	Required	Description
payload	pricefx:ListSellersRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListSellersEnvelope|error

Sample code:

pricefx:ListSellersEnvelope result = check pricefxClient->listSellers(payload);

updateSeller

Update a Seller

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateSellerRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateSellerEnvelope|error

Sample code:

pricefx:UpdateSellerEnvelope result = check pricefxClient->updateSeller(payload);

Seller Extensions

addSellerExtension

Add a Seller Extension

Parameters:

Name	Type	Required	Description
payload	pricefx:AddSellerExtensionRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddSellerExtensionResponse|error

Sample code:

pricefx:AddSellerExtensionResponse result = check pricefxClient->addSellerExtension(payload);

deleteSellerExtension

Delete a Seller Extension

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteSellerExtensionRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteSellerExtensionResponse|error

Sample code:

pricefx:DeleteSellerExtensionResponse result = check pricefxClient->deleteSellerExtension(payload);

getSellerExtension

Get a Seller Extension

Parameters:

Name	Type	Required	Description
sellerId	string	Yes	The SellerId of the seller in the Seller Extension table you want to retrieve details for
sXCategory	string	Yes	The Seller Extension category (the Name from the Seller Master Extension table)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SellerExtensionEnvelope|error

Sample code:

pricefx:SellerExtensionEnvelope result = check pricefxClient->getSellerExtension(sellerId, sXCategory);

importSellerExtensionFile

Import a File

Parameters:

Name	Type	Required	Description
sXCategory	string	Yes	The Seller Extension category (the Name from the Seller Master Extension table)
slotId	string	Yes	The ID that is returned by the /uploadmanager.newuploadslot (Create an Upload Slot) endpoint
payload	pricefx:ImportSXFileRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ImportSellerExtensionFileQueries	Yes	Queries to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->importSellerExtensionFile(sXCategory, slotId, payload, queries);

insertBulkSellerExtensions

Insert Bulk Seller Extensions

Parameters:

Name	Type	Required	Description
payload	pricefx:InsertBulkProductExtensionsRequest1	Yes	Specify seller extension field names in the header object and field values in the data object
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->insertBulkSellerExtensions(payload);

listSellerExtensions

List Seller Extensions

Parameters:

Name	Type	Required	Description
sXCategory	string	Yes	The Seller Extension category (the Name from the Seller Master Extension table)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SellerExtensionEnvelope|error

Sample code:

pricefx:SellerExtensionEnvelope result = check pricefxClient->listSellerExtensions(sXCategory);

updateSellerExtension

Update a Seller Extension

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateSXBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateSellerExtensionEnvelope|error

Sample code:

pricefx:UpdateSellerExtensionEnvelope result = check pricefxClient->updateSellerExtension(payload);

Condition Records

addConditionRecordItemMeta

Add a Condition Record Item Attribute Meta

Parameters:

Name	Type	Required	Description
payload	pricefx:AddCRCIMBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordItemMetaOperationEnvelope|error

Sample code:

pricefx:ConditionRecordItemMetaOperationEnvelope result = check pricefxClient->addConditionRecordItemMeta(payload);

addConditionRecordSet

Add a Condition Record Set

Parameters:

Name	Type	Required	Description
payload	pricefx:AddCRCSBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordSetOperationEnvelope|error

Sample code:

pricefx:ConditionRecordSetOperationEnvelope result = check pricefxClient->addConditionRecordSet(payload);

deleteConditionRecordItemMeta

Delete a Condition Record Item Attribute Meta

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCRCIMBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordItemMetaOperationEnvelope|error

Sample code:

pricefx:ConditionRecordItemMetaOperationEnvelope result = check pricefxClient->deleteConditionRecordItemMeta(payload);

deleteConditionRecordSet

Delete a Condition Records Set

Parameters:

Name	Type	Required	Description
payload	pricefx:DcrmanagerDeletemassopidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordSetOperationEnvelope|error

Sample code:

pricefx:ConditionRecordSetOperationEnvelope result = check pricefxClient->deleteConditionRecordSet(payload);

getConditionRecordItem

Get a Condition Record Item

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordItemEnvelope|error

Sample code:

pricefx:ConditionRecordItemEnvelope result = check pricefxClient->getConditionRecordItem(payload);

getConditionRecordItemMeta

Get a Condition Record Item Attribute Meta

Parameters:

Name	Type	Required	Description
payload	pricefx:FetchCRCIMBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordItemMetaEnvelope|error

Sample code:

pricefx:ConditionRecordItemMetaEnvelope result = check pricefxClient->getConditionRecordItemMeta(payload);

getConditionRecordSetItems

Get Condition Record Set Items With Set Id Validation

Parameters:

Name	Type	Required	Description
payload	pricefx:ConditionrecordsetFetchCRCI3Body	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordSetItemsEnvelope|error

Sample code:

pricefx:ConditionRecordSetItemsEnvelope result = check pricefxClient->getConditionRecordSetItems(payload);

listConditionRecordSets

List Condition Record Sets

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListConditionRecordSetsEnvelope|error

Sample code:

pricefx:ListConditionRecordSetsEnvelope result = check pricefxClient->listConditionRecordSets(payload);

updateConditionRecordItemMeta

Update a Condition Record Item Attribute Meta + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCRCIMBody	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateConditionRecordItemMetaEnvelope|error

Sample code:

pricefx:UpdateConditionRecordItemMetaEnvelope result = check pricefxClient->updateConditionRecordItemMeta(payload);

updateConditionRecordSet

Update a Condition Record Set

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the ConditionRecordSet object you want to update
payload	pricefx:ConditionrecordsetUpdateidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConditionRecordSetOperationEnvelope|error

Sample code:

pricefx:ConditionRecordSetOperationEnvelope result = check pricefxClient->updateConditionRecordSet(id, payload);

Price Lists

addPriceListType

Add a Price List Type + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:AddPLTTBody	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceListTypeOperationEnvelope|error

Sample code:

pricefx:PriceListTypeOperationEnvelope result = check pricefxClient->addPriceListType(payload);

calculatePriceList

Calculate a Pricelist

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:PricelistmanagerCalculateidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CalculatePricelistResponse|error

Sample code:

pricefx:CalculatePricelistResponse result = check pricefxClient->calculatePriceList(id, payload);

createPriceList

Create a Price List

Parameters:

Name	Type	Required	Description
payload	pricefx:CreatePriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CreatePriceListResponse|error

Sample code:

pricefx:CreatePriceListResponse result = check pricefxClient->createPriceList(payload);

createPriceListRevision

Create a Revision

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:CreateRevisionRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceListItemResponse|error

Sample code:

pricefx:PriceListItemResponse result = check pricefxClient->createPriceListRevision(id, payload);

deletePriceList

Delete a Price List

Parameters:

Name	Type	Required	Description
payload	pricefx:DeletePriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeletePriceListResponse|error

Sample code:

pricefx:DeletePriceListResponse result = check pricefxClient->deletePriceList(payload);

deletePriceListItems

Delete a Price List Item

Parameters:

Name	Type	Required	Description
id	string	Yes	Enter the ID of the Price List where you want to delete an item from
payload	pricefx:DeletePriceListItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeletePriceListItemResponse|error

Sample code:

pricefx:DeletePriceListItemResponse result = check pricefxClient->deletePriceListItems(id, payload);

deletePriceListType

Delete a Price List Type

Parameters:

Name	Type	Required	Description
payload	pricefx:DeletePLTTBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceListTypeOperationEnvelope|error

Sample code:

pricefx:PriceListTypeOperationEnvelope result = check pricefxClient->deletePriceListType(payload);

getPriceList

Get a Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:GetPriceListResponse|error

Sample code:

pricefx:GetPriceListResponse result = check pricefxClient->getPriceList(id);

listPriceListItems

List Price List Items

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:ListPriceListItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceListItemResponse|error

Sample code:

pricefx:PriceListItemResponse result = check pricefxClient->listPriceListItems(id, payload);

listPriceListTypes

List Price List Types

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListPriceListTypesEnvelope|error

Sample code:

pricefx:ListPriceListTypesEnvelope result = check pricefxClient->listPriceListTypes();

listPriceLists

List Price Lists

Parameters:

Name	Type	Required	Description
payload	pricefx:ListPriceListsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListPriceListsResponse|error

Sample code:

pricefx:ListPriceListsResponse result = check pricefxClient->listPriceLists(payload);

revokePriceList

Revoke a Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	The id to be sent with the request
payload	pricefx:PricelistmanagerSubmitidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceListItemResponse|error

Sample code:

pricefx:PriceListItemResponse result = check pricefxClient->revokePriceList(id, payload);

submitPriceList

Submit a Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:PricelistmanagerSubmitidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceListItemResponse|error

Sample code:

pricefx:PriceListItemResponse result = check pricefxClient->submitPriceList(id, payload);

updatePriceListDetail

Update a Pricelist Detail

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:UpdatePricelistDetailRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdatePricelistDetailResponse|error

Sample code:

pricefx:UpdatePricelistDetailResponse result = check pricefxClient->updatePriceListDetail(id, payload);

updatePriceListType

Update a Price List Type

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdatePLTTBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceListTypeOperationEnvelope|error

Sample code:

pricefx:PriceListTypeOperationEnvelope result = check pricefxClient->updatePriceListType(payload);

Manual Price Lists

addManualPriceListProducts

Add Products to a Manual Pricelist

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List where you want to add products to
payload	pricefx:AddProductsToManualPriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->addManualPriceListProducts(id, payload);

addManualPriceListProductsNoRecalc

Add Products to a Manual Price List (No Recalculation)

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List where you want to add products to
payload	pricefx:AddProductsToManualPriceListNoRecalcRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddProductsToManualPriceListNoRecalcResponse|error

Sample code:

pricefx:AddProductsToManualPriceListNoRecalcResponse result = check pricefxClient->addManualPriceListProductsNoRecalc(id, payload);

calculateManualPriceList

Calculate a Manual Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List you want to start the calculation for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CalculateManualPriceListResponse|error

Sample code:

pricefx:CalculateManualPriceListResponse result = check pricefxClient->calculateManualPriceList(id);

copyManualPriceList

Copy a Manual Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List you want to copy
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ManualPriceListResponse|error

Sample code:

pricefx:ManualPriceListResponse result = check pricefxClient->copyManualPriceList(id);

createManualPriceList

Create a Manual Price List

Parameters:

Name	Type	Required	Description
payload	pricefx:CreateManualPriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ManualPriceListResponse|error

Sample code:

pricefx:ManualPriceListResponse result = check pricefxClient->createManualPriceList(payload);

deleteManualPriceList

Delete a Manual Price List

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteManualPriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ManualPriceListResponse|error

Sample code:

pricefx:ManualPriceListResponse result = check pricefxClient->deleteManualPriceList(payload);

deleteManualPriceListProduct

Delete a Product from a Manual Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List whose product you want to delete
payload	pricefx:DeleteProductFromManualPriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->deleteManualPriceListProduct(id, payload);

deleteManualPriceListProducts

Delete Products from a Manual Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List whose products you want to delete
payload	pricefx:DeleteProductsFromManualPriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteProductsFromManualPriceListResponse|error

Sample code:

pricefx:DeleteProductsFromManualPriceListResponse result = check pricefxClient->deleteManualPriceListProducts(id, payload);

listManualPriceListProducts

List Products From a Manual Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List you want to retrieve products from
payload	pricefx:ListProductsFromManualPriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListProductsFromManualPriceListResponse|error

Sample code:

pricefx:ListProductsFromManualPriceListResponse result = check pricefxClient->listManualPriceListProducts(id, payload);

listManualPriceLists

List Manual Price Lists

Parameters:

Name	Type	Required	Description
payload	pricefx:ListManualPriceListsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ManualPriceListResponse|error

Sample code:

pricefx:ManualPriceListResponse result = check pricefxClient->listManualPriceLists(payload);

massEditManualPriceListItems

Mass Edit a Manual Price List Items

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List whose products you want to update
payload	pricefx:MassEditMPLRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassEditManualPriceListResponse|error

Sample code:

pricefx:MassEditManualPriceListResponse result = check pricefxClient->massEditManualPriceListItems(id, payload);

updateManualPriceListItem

Update a Manual Price List Item

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List whose item you want to update
payload	pricefx:UpdateManualPriceListRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateManualPriceListResponse|error

Sample code:

pricefx:UpdateManualPriceListResponse result = check pricefxClient->updateManualPriceListItem(id, payload);

upsertManualPriceListProduct

Upsert a Product in a Manual Price List + payload -

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Manual Price List whose product you want to create or update
payload	pricefx:UpsertProductManualPriceListRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->upsertManualPriceListProduct(id, payload);

Calculation Grids

acceptCalculationGridItem

Submit a Calculation Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:SubmitCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitCalculationGridItemResponse|error

Sample code:

pricefx:SubmitCalculationGridItemResponse result = check pricefxClient->acceptCalculationGridItem(id, payload);

addCalculationGrid

Add a Calculation Grid

Parameters:

Name	Type	Required	Description
payload	pricefx:AddCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddCalculationGridResponse|error

Sample code:

pricefx:AddCalculationGridResponse result = check pricefxClient->addCalculationGrid(payload);

addCalculationGridItem

Add a Calculation Grid Item

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
payload	pricefx:AddCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddCalculationGridItemResponse|error

Sample code:

pricefx:AddCalculationGridItemResponse result = check pricefxClient->addCalculationGridItem(keyNumber, payload);

calculateCalculationGrid

Calculate a Calculation Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Calculation Grid you want to calculate
payload	pricefx:CalculateCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CalculateCalculationGridResponse|error

Sample code:

pricefx:CalculateCalculationGridResponse result = check pricefxClient->calculateCalculationGrid(id, payload);

deleteCalculationGrid

Delete a Calculation Grid

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCalculationGridResponse|error

Sample code:

pricefx:DeleteCalculationGridResponse result = check pricefxClient->deleteCalculationGrid(payload);

deleteCalculationGridItem

Delete a Calculation Grid Item

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
payload	pricefx:DeleteCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCalculationGridItemResponse|error

Sample code:

pricefx:DeleteCalculationGridItemResponse result = check pricefxClient->deleteCalculationGridItem(keyNumber, payload);

getCalculationGrid

Get a Calculation Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	ID of the Calculation Grid you want to retrieve
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetCalculationGridResponse|error

Sample code:

pricefx:GetCalculationGridResponse result = check pricefxClient->getCalculationGrid(id, payload);

getCalculationGridItem

Get a Calculation Grid Item

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
id	string	Yes	id of the Calculation Grid Item you want to fetch
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetCalculationGridItemResponse|error

Sample code:

pricefx:GetCalculationGridItemResponse result = check pricefxClient->getCalculationGridItem(keyNumber, id, payload);

listCalculationGridItems

List Calculation Grid Items

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
payload	pricefx:ListCalculationGridItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCalculationGridItemsResponse|error

Sample code:

pricefx:ListCalculationGridItemsResponse result = check pricefxClient->listCalculationGridItems(keyNumber, payload);

listCalculationGrids

List Calculation Grids

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCalculationGridsResponse|error

Sample code:

pricefx:ListCalculationGridsResponse result = check pricefxClient->listCalculationGrids(payload);

rejectCalculationGridItem

Deny a Calculation Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:DenyCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DenyCalculationGridItemResponse|error

Sample code:

pricefx:DenyCalculationGridItemResponse result = check pricefxClient->rejectCalculationGridItem(id, payload);

updateCalculationGrid

Update a Calculation Grid

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCalculationGridResponse|error

Sample code:

pricefx:UpdateCalculationGridResponse result = check pricefxClient->updateCalculationGrid(payload);

updateCalculationGridItem

Update a Calculation Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Calculation Grid Item you want to update
payload	pricefx:UpdateCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCalculationGridItemResponse|error

Sample code:

pricefx:UpdateCalculationGridItemResponse result = check pricefxClient->updateCalculationGridItem(id, payload);

Calculated Field Sets

calculateCfs

Calculate a CFS

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:CalculateCFSResponse|error

Sample code:

pricefx:CalculateCFSResponse result = check pricefxClient->calculateCfs(id);

cancelCfsCalculation

Cancel a CFS Calculation

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->cancelCfsCalculation(id);

deleteCalculatedFieldSet

Delete a Calculated Field Set

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCalculatedFieldSetRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->deleteCalculatedFieldSet(payload);

listCalculatedFieldSets

List Calculated Field Sets

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCalculatedFieldSetsResponse|error

Sample code:

pricefx:ListCalculatedFieldSetsResponse result = check pricefxClient->listCalculatedFieldSets();

Live Price Grids

addLivePriceGridType

Add a Live Price Grid Type

Parameters:

Name	Type	Required	Description
payload	pricefx:AddPGTTBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LivePriceGridTypeOperationEnvelope|error

Sample code:

pricefx:LivePriceGridTypeOperationEnvelope result = check pricefxClient->addLivePriceGridType(payload);

addPriceGridItemsToPriceGrid

Add Price Grid Items to a Price Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:AddPriceGridItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddPriceGridItemsToPriceGridResponse|error

Sample code:

pricefx:AddPriceGridItemsToPriceGridResponse result = check pricefxClient->addPriceGridItemsToPriceGrid(id, payload);

calculatePriceGrid

Calculate a Price Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	The id to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CalculatePriceGridResponse|error

Sample code:

pricefx:CalculatePriceGridResponse result = check pricefxClient->calculatePriceGrid(id);

cancelPriceGridCalculation

Cancel a Calculation

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Live Price Grid whose running calculation should be cancelled
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CancelCalculationResponse|error

Sample code:

pricefx:CancelCalculationResponse result = check pricefxClient->cancelPriceGridCalculation(id);

convertToPriceList

Convert to Price List

Parameters:

Name	Type	Required	Description
id	string	Yes	The id to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConvertPriceListResponse|error

Sample code:

pricefx:ConvertPriceListResponse result = check pricefxClient->convertToPriceList(id);

copyPriceGrid

Copy a Price Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:CopyPriceGridResponse|error

Sample code:

pricefx:CopyPriceGridResponse result = check pricefxClient->copyPriceGrid(id);

countMassActionItems

Count Mass Action Items

Parameters:

Name	Type	Required	Description
id	string	Yes	The id to be sent with the request
payload	pricefx:CountMassActionItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CountMassActionItemsResponse|error

Sample code:

pricefx:CountMassActionItemsResponse result = check pricefxClient->countMassActionItems(id, payload);

deleteLivePriceGrid

Delete a Live Price Grid

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteLivePriceGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteLivePriceGridResponse|error

Sample code:

pricefx:DeleteLivePriceGridResponse result = check pricefxClient->deleteLivePriceGrid(payload);

deleteLivePriceGridType

Delete a Live Price Grid Type + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:DeletePLTTBody	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LivePriceGridTypeOperationEnvelope|error

Sample code:

pricefx:LivePriceGridTypeOperationEnvelope result = check pricefxClient->deleteLivePriceGridType(payload);

deletePriceGridItem

Delete a Price Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Price Grid you want to delete the Price Grid Item from
payload	pricefx:DeletePriceGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceGridItemResponse|error

Sample code:

pricefx:PriceGridItemResponse result = check pricefxClient->deletePriceGridItem(id, payload);

deletePriceGridItemFilter

Delete a Price Grid Item (Filter) + payload -

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Price Grid that contains Price Grid Items you want to delete
payload	pricefx:DeletePriceGridItemFilterRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->deletePriceGridItemFilter(id, payload);

denyLivePriceGridItem

Deny a Live Price Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Price Grid that contains the Price Grid Item you want to deny
payload	pricefx:DenyLivePriceGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceGridItemResponse|error

Sample code:

pricefx:PriceGridItemResponse result = check pricefxClient->denyLivePriceGridItem(id, payload);

downloadLivePriceGridExcelFile

Download a Live Price Grid Excel File

Parameters:

Name	Type	Required	Description
id1	string	Yes	The id1 to be sent with the request
id2	string	Yes	The id2 to be sent with the request
id3	string	Yes	The id3 to be sent with the request
id4	string	Yes	The id4 to be sent with the request
id5	string	Yes	The id5 to be sent with the request
id6	string	Yes	The id6 to be sent with the request
id7	string	Yes	The id7 to be sent with the request
id8	string	Yes	The id8 to be sent with the request
id9	string	Yes	The id9 to be sent with the request
id10	string	Yes	The id10 to be sent with the request
id11	string	Yes	The id11 to be sent with the request
id12	string	Yes	The id12 to be sent with the request
id13	string	Yes	IDs of the Price Grids you want to download
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:DownloadLivePriceGridExcelFileQueries	Yes	Queries to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->downloadLivePriceGridExcelFile(id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, id12, id13, queries);

getLivePriceGrid

Get a Live Price Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:GetLivePriceGridResponse|error

Sample code:

pricefx:GetLivePriceGridResponse result = check pricefxClient->getLivePriceGrid(id);

listLivePriceGridItems

List Live Price Grid Items

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:ListLivePriceGridItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListLivePriceGridItemsResponse|error

Sample code:

pricefx:ListLivePriceGridItemsResponse result = check pricefxClient->listLivePriceGridItems(id, payload);

listLivePriceGridTypes

List Live Price Grid Types

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListLivePriceGridTypesEnvelope|error

Sample code:

pricefx:ListLivePriceGridTypesEnvelope result = check pricefxClient->listLivePriceGridTypes();

listLivePriceGrids

List Live Price Grids

Parameters:

Name	Type	Required	Description
payload	pricefx:ListLivePriceGridsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListLivePriceGridsResponse|error

Sample code:

pricefx:ListLivePriceGridsResponse result = check pricefxClient->listLivePriceGrids(payload);

massEditPriceGridItems

Mass Edit Price Grid Items

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:MassEditPriceGridItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassEditPriceGridItemsResponse|error

Sample code:

pricefx:MassEditPriceGridItemsResponse result = check pricefxClient->massEditPriceGridItems(id, payload);

performMassAction

Perform a Mass Action

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the Price Grid that contains items you want to apply workflow actions to
payload	pricefx:PerformMassActionRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PerformMassActionResponse|error

Sample code:

pricefx:PerformMassActionResponse result = check pricefxClient->performMassAction(id, payload);

submitProducts

Submit Products

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:SubmitProductsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitProductsResponse|error

Sample code:

pricefx:SubmitProductsResponse result = check pricefxClient->submitProducts(id, payload);

updateLivePriceGridItem

Update a Live Price Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:UpdateLivePriceGridItemRequest	Yes	We have performed an update action on the comments field in our request sample >>>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceGridItemResponse|error

Sample code:

pricefx:PriceGridItemResponse result = check pricefxClient->updateLivePriceGridItem(id, payload);

updateLivePriceGridItemNo

Update a Live Price Grid Item (No Recalculation)

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:UpdateLivePriceGridItemNoRecalcRequest	Yes	We have performed an update action on the comments field in our request sample >>>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PriceGridItemResponse|error

Sample code:

pricefx:PriceGridItemResponse result = check pricefxClient->updateLivePriceGridItemNo(id, payload);

updateLivePriceGridType

Update a Live Price Grid Type

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdatePGTTBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LivePriceGridTypeOperationEnvelope|error

Sample code:

pricefx:LivePriceGridTypeOperationEnvelope result = check pricefxClient->updateLivePriceGridType(payload);

Quotes

addQuoteProducts

Add Products to a Quote

Parameters:

Name	Type	Required	Description
payload	pricefx:AddProductsToQuoteRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->addQuoteProducts(payload);

convertQuoteToDeal

Convert to a Deal

Parameters:

Name	Type	Required	Description
identifier	string	Yes	Can be either the uniqueName or the typedId
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->convertQuoteToDeal(identifier);

copyQuote

Copy a Quote

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CopyQuoteEnvelope|error

Sample code:

pricefx:CopyQuoteEnvelope result = check pricefxClient->copyQuote(typedId, payload);

createClic

Create a Quote

Parameters:

Name	Type	Required	Description
typeCode	"Q"|"QTMP"	Yes	Enter the type code of the entity you want to create
payload	pricefx:ClicmanagerCreateTypeCodeBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ClicOperationEnvelope|error

Sample code:

pricefx:ClicOperationEnvelope result = check pricefxClient->createClic(typeCode, payload);

createQuoteRevision

Create a New Revision

Parameters:

Name	Type	Required	Description
identifier	string	Yes	Can be either the uniqueName or the typedId
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->createQuoteRevision(identifier);

exportQuoteDocx

Export a DOCX File

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	Specify the uniqueName of the quote you want to download
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ExportQuoteDocxQueries	Yes	Queries to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->exportQuoteDocx(uniqueName, queries);

exportQuoteExcel

Export an Excel File

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	Specify the uniqueName of the quote you want to download
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ExportQuoteExcelQueries	Yes	Queries to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->exportQuoteExcel(uniqueName, queries);

exportQuotePdf

Export a PDF File

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	Specify the uniqueName of the quote you want to download
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ExportQuotePdfQueries	Yes	Queries to be sent with the request

Returns: record

Sample code:

record result = check pricefxClient->exportQuotePdf(uniqueName, queries);

getClicDraftHeader

Get a Temporary Data

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Quote you want to retrieve the temporary data from
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ClicDraftHeaderEnvelope|error

Sample code:

pricefx:ClicDraftHeaderEnvelope result = check pricefxClient->getClicDraftHeader(typedId, payload);

getClicFolderStats

Get Folder Statistics

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the document whose folder statistics you want to fetch
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:GetClicFolderStatsQueries	Yes	Queries to be sent with the request

Returns: pricefx:ClicFolderStatsEnvelope|error

Sample code:

pricefx:ClicFolderStatsEnvelope result = check pricefxClient->getClicFolderStats(typedId, queries);

getQuote

Get a Quote

Parameters:

Name	Type	Required	Description
typedID	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->getQuote(typedID);

listQuoteProducts

List Products

Parameters:

Name	Type	Required	Description
payload	pricefx:ListProductsRequest1	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->listQuoteProducts(payload);

listQuotes

List Quotes

Parameters:

Name	Type	Required	Description
payload	pricefx:ListQuotesRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListQuotesResponse|error

Sample code:

pricefx:ListQuotesResponse result = check pricefxClient->listQuotes(payload);

markQuoteLost

Mark an Offer as Lost

Parameters:

Name	Type	Required	Description
identifier	string	Yes	Can be either the uniqueName or the typedId
payload	pricefx:MarkOfferAsLostRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->markQuoteLost(identifier, payload);

recalculateQuote

Recalculate a Quote

Parameters:

Name	Type	Required	Description
payload	pricefx:RecalculateQuoteRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->recalculateQuote(payload);

revokeQuote

Revoke a Deal

Parameters:

Name	Type	Required	Description
identifier	string	Yes	Can be either the uniqueName or the typedId
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RevokeDealResponse|error

Sample code:

pricefx:RevokeDealResponse result = check pricefxClient->revokeQuote(identifier);

saveClicDraft

Save a Temporary Data

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Temporary Quote you want to save
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ClicOperationEnvelope|error

Sample code:

pricefx:ClicOperationEnvelope result = check pricefxClient->saveClicDraft(typedId, payload);

submitQuote

Submit a Quote

Parameters:

Name	Type	Required	Description
payload	pricefx:SubmitQuoteRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->submitQuote(payload);

undoRevokeQuote

Undo Quote Revocation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->undoRevokeQuote(typedId);

upsertQuote

Upsert a Quote

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertQuoteRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QuoteResponse|error

Sample code:

pricefx:QuoteResponse result = check pricefxClient->upsertQuote(payload);

Contracts (Agreements & Promotions)

addContractLineItems

Add Contract Line Items

Parameters:

Name	Type	Required	Description
payload	pricefx:AddContractLineItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ContractModelResponse|error

Sample code:

pricefx:ContractModelResponse result = check pricefxClient->addContractLineItems(payload);

exportContractPdf

Export a PDF File

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	Specify the uniqueName of the A&P you want to download
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->exportContractPdf(uniqueName);

getContract

Get a Contract

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	uniqueName of the Contract you want to retrieve details for. Alternatively, typedId can be also used
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ContractModelResponse|error

Sample code:

pricefx:ContractModelResponse result = check pricefxClient->getContract(uniqueName);

listContractCalculations

List Contract Calculations

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListContractCalculationsEnvelope|error

Sample code:

pricefx:ListContractCalculationsEnvelope result = check pricefxClient->listContractCalculations(payload);

listContractPriceRecords

List Contract Price Records

Parameters:

Name	Type	Required	Description
payload	pricefx:FetchCPRBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListContractPriceRecords|error

Sample code:

pricefx:ListContractPriceRecords result = check pricefxClient->listContractPriceRecords(payload);

listContracts

List Contracts

Parameters:

Name	Type	Required	Description
payload	pricefx:ListContractsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ContractResponse|error

Sample code:

pricefx:ContractResponse result = check pricefxClient->listContracts(payload);

submitContract

Submit a Contract

Parameters:

Name	Type	Required	Description
payload	pricefx:SubmitContractRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ContractModelResponse|error

Sample code:

pricefx:ContractModelResponse result = check pricefxClient->submitContract(payload);

undoRevokeContract

Undo Agreement & Promotion Revocation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->undoRevokeContract(typedId);

upsertContract

Upsert a Contract

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertContractRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ContractModelResponse|error

Sample code:

pricefx:ContractModelResponse result = check pricefxClient->upsertContract(payload);

Rebate Agreements

addRebateAgreementItems

Add Rebate Agreement Items

Parameters:

Name	Type	Required	Description
payload	pricefx:GetCustomerRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RebateAgreementResponse|error

Sample code:

pricefx:RebateAgreementResponse result = check pricefxClient->addRebateAgreementItems(payload);

deleteRebateAgreement

Delete a Rebate Agreement

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteRebateAgreementRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RebateAgreementResponse|error

Sample code:

pricefx:RebateAgreementResponse result = check pricefxClient->deleteRebateAgreement(payload);

getRebateAgreement

Get a Rebate Agreement

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The uniqueName of the Rebate Agreement you want to retrieve details for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RebateAgreementResponse|error

Sample code:

pricefx:RebateAgreementResponse result = check pricefxClient->getRebateAgreement(uniqueName);

listRebateAgreementItems

List Rebate Agreement Items

Parameters:

Name	Type	Required	Description
payload	pricefx:ListRebateAgreementItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListRebateAgreementItemsResponse|error

Sample code:

pricefx:ListRebateAgreementItemsResponse result = check pricefxClient->listRebateAgreementItems(payload);

listRebateAgreements

List Rebate Agreements

Parameters:

Name	Type	Required	Description
payload	pricefx:ListRebateAgreementsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListRebateAgreementsResponse|error

Sample code:

pricefx:ListRebateAgreementsResponse result = check pricefxClient->listRebateAgreements(payload);

undoRebateAgreementRevocation

Undo Rebate Agreement Revocation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->undoRebateAgreementRevocation(typedId);

undoRebateRecordRevocation

Undo Rebate Record Revocation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->undoRebateRecordRevocation(typedId);

upsertRebateAgreement

Upsert a Rebate Agreement

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertRebateAgreementRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RebateAgreementResponse|error

Sample code:

pricefx:RebateAgreementResponse result = check pricefxClient->upsertRebateAgreement(payload);

Rebate Calculations

addRebateCalculation

Add a Rebate Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:AddRRSCBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddRebateCalculationResponse|error

Sample code:

pricefx:AddRebateCalculationResponse result = check pricefxClient->addRebateCalculation(payload);

deleteRebateCalculation

Delete a Rebate Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteRebateCalculationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteRebateCalculationResponse|error

Sample code:

pricefx:DeleteRebateCalculationResponse result = check pricefxClient->deleteRebateCalculation(payload);

listRebateCalculations

List Rebate Calculations

Parameters:

Name	Type	Required	Description
payload	pricefx:FetchRRSCBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListRebateCalculationsResponse|error

Sample code:

pricefx:ListRebateCalculationsResponse result = check pricefxClient->listRebateCalculations(payload);

runRebateCalculation

Run a Rebate Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:RebaterecordCalculatesetBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RunRebateCalculationResponse|error

Sample code:

pricefx:RunRebateCalculationResponse result = check pricefxClient->runRebateCalculation(payload);

saveRebateCalculation

Save a Rebate Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:SaveRebateCalculationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SaveRebateCalculationResponse|error

Sample code:

pricefx:SaveRebateCalculationResponse result = check pricefxClient->saveRebateCalculation(payload);

Rebate Record Group

calculateRebateRecordGroup

Calculate a Rebate Record Group

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Rebate Record Group you want to calculate
payload	pricefx:RebaterecordgroupCalculatetypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CalculateRebateRecordGroupEnvelope|error

Sample code:

pricefx:CalculateRebateRecordGroupEnvelope result = check pricefxClient->calculateRebateRecordGroup(typedId, payload);

getRebateRecordGroup

Get a Rebate Record Group

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->getRebateRecordGroup(payload);

massSubmitRebateRecordGroupItems

Mass Submit Rebate Record Groups

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	pricefx:RebaterecordgroupMasssubmittypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassSubmitRRGResponse|error

Sample code:

pricefx:MassSubmitRRGResponse result = check pricefxClient->massSubmitRebateRecordGroupItems(typedId, payload);

massSubmitRebateRecordGroups

Mass Submit Rebate Record Groups

Parameters:

Name	Type	Required	Description
payload	pricefx:RebaterecordgroupMasssubmittypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassSubmitRebateRecordGroupsEnvelope|error

Sample code:

pricefx:MassSubmitRebateRecordGroupsEnvelope result = check pricefxClient->massSubmitRebateRecordGroups(payload);

previewRebateRecordGroupWorkflow

Preview a Rebate Record Group Workflow

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	pricefx:RebaterecordgroupPreviewtypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RebateRecordGroupWorkflowEnvelope|error

Sample code:

pricefx:RebateRecordGroupWorkflowEnvelope result = check pricefxClient->previewRebateRecordGroupWorkflow(typedId, payload);

revokeRebateRecordGroup

Revoke a Rebate Record Group

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Rebate Record Group you want to revoke
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RevokeRebateRecordGroupEnvelope|error

Sample code:

pricefx:RevokeRebateRecordGroupEnvelope result = check pricefxClient->revokeRebateRecordGroup(typedId);

shouldSubmitRrgAsynchronously

Should Submit a RRG Asynchronously

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Rebate Record Group you want to return the async threshold boolean for
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CheckFileExistsEnvelope|error

Sample code:

pricefx:CheckFileExistsEnvelope result = check pricefxClient->shouldSubmitRrgAsynchronously(typedId, payload);

submitRebateRecordGroup

Submit a Rebate Record Group

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Rebate Record Group you want to submit
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitRebateRecordGroup|error

Sample code:

pricefx:SubmitRebateRecordGroup result = check pricefxClient->submitRebateRecordGroup(typedId, payload);

undoRebateRecordGroupRevocation

Undo Rebate Record Group Revocation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->undoRebateRecordGroupRevocation(typedId);

Sales Compensations

addCalculation

Add a Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:AddCalculationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddCalculationResponse|error

Sample code:

pricefx:AddCalculationResponse result = check pricefxClient->addCalculation(payload);

addCompensationType

Add a Compensation Type

Parameters:

Name	Type	Required	Description
payload	pricefx:AddCompensationTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddCompensationTypeEnvelope|error

Sample code:

pricefx:AddCompensationTypeEnvelope result = check pricefxClient->addCompensationType(payload);

addConditionType

Add a Condition Type + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:AddConditionTypeRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddConditionTypeEnvelope|error

Sample code:

pricefx:AddConditionTypeEnvelope result = check pricefxClient->addConditionType(payload);

deleteCalculation

Delete a Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCalculationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCalculationResponse|error

Sample code:

pricefx:DeleteCalculationResponse result = check pricefxClient->deleteCalculation(payload);

deleteCompensationPlan

Delete a Compensation Plan

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCompensationPlanRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCompensationPlanResponse|error

Sample code:

pricefx:DeleteCompensationPlanResponse result = check pricefxClient->deleteCompensationPlan(payload);

deleteCompensationType

Delete a Compensation Type

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCOHTBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCompensationTypeEnvelope|error

Sample code:

pricefx:DeleteCompensationTypeEnvelope result = check pricefxClient->deleteCompensationType(payload);

deleteConditionType

Delete a Condition Type

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteConditionTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteConditionTypeEnvelope|error

Sample code:

pricefx:DeleteConditionTypeEnvelope result = check pricefxClient->deleteConditionType(payload);

duplicateCompensationPlan

Duplicate a Compensation Plan

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Compensation Plan you want to duplicate
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DuplicateCompensationPlanEnvelope|error

Sample code:

pricefx:DuplicateCompensationPlanEnvelope result = check pricefxClient->duplicateCompensationPlan(typedId);

getSignatureStatus

Get a Signature Status

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Compensation document you want to retrieve the signature status for
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetSignatureStatusResponse|error

Sample code:

pricefx:GetSignatureStatusResponse result = check pricefxClient->getSignatureStatus(typedId, payload);

getSignedDocument

Get a Signed Document

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	A uniqueName of the Compensation Plan you want to download a signed file for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->getSignedDocument(uniqueName);

listAccrualRecords

List Accrual Records

Parameters:

Name	Type	Required	Description
payload	pricefx:ListAccrualRecordsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListAccrualRecordsResponse|error

Sample code:

pricefx:ListAccrualRecordsResponse result = check pricefxClient->listAccrualRecords(payload);

listCalculations

List Calculations

Parameters:

Name	Type	Required	Description
payload	pricefx:ListCalculationsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCalculationsResponse|error

Sample code:

pricefx:ListCalculationsResponse result = check pricefxClient->listCalculations(payload);

listCompensationPlans

List Compensation Plans

Parameters:

Name	Type	Required	Description
payload	pricefx:ListCompensationPlansRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCompensationPlansResponse|error

Sample code:

pricefx:ListCompensationPlansResponse result = check pricefxClient->listCompensationPlans(payload);

listCompensationRecords

List Compensation Records

Parameters:

Name	Type	Required	Description
compensationRecordSetId	string	Yes	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	pricefx:ListCompensationRecordsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCompensationRecordsResponse|error

Sample code:

pricefx:ListCompensationRecordsResponse result = check pricefxClient->listCompensationRecords(compensationRecordSetId, payload);

listCompensationTypes

List Compensation Types

Parameters:

Name	Type	Required	Description
payload	pricefx:ListCompensationTypesRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCompensationTypesEnvelope|error

Sample code:

pricefx:ListCompensationTypesEnvelope result = check pricefxClient->listCompensationTypes(payload);

listConditionTypes

List Condition Types

Parameters:

Name	Type	Required	Description
payload	pricefx:ListConditionTypesRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListConditionTypesEnvelope|error

Sample code:

pricefx:ListConditionTypesEnvelope result = check pricefxClient->listConditionTypes(payload);

recalculateQuoteContractRebate

Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the document you want to calculate
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:RecalculateQuoteContractRebateQueries	Yes	Queries to be sent with the request

Returns: pricefx:RecalculateClicEnvelope|error

Sample code:

pricefx:RecalculateClicEnvelope result = check pricefxClient->recalculateQuoteContractRebate(typedId, queries);

revokeCompensationRecord

Revoke a Compensation Record

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Compensation Record you want to revoke
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->revokeCompensationRecord(typedId);

runCalculation

Run a Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:RunCalculationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RunCalculationResponse|error

Sample code:

pricefx:RunCalculationResponse result = check pricefxClient->runCalculation(payload);

saveCalculation

Save Calculation

Parameters:

Name	Type	Required	Description
payload	pricefx:SaveCalculationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SaveCalculationResponse|error

Sample code:

pricefx:SaveCalculationResponse result = check pricefxClient->saveCalculation(payload);

saveCompensationRecord

Save a Compensation Record

Parameters:

Name	Type	Required	Description
payload	pricefx:SaveCompensationRecordRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SaveCompensationRecordResponse|error

Sample code:

pricefx:SaveCompensationRecordResponse result = check pricefxClient->saveCompensationRecord(payload);

sendDocumentToSign

Send a Document to Sign

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Compensation whose data you want to send via the e-signature system
payload	pricefx:CreateSignatureRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CreateSignatureResponse|error

Sample code:

pricefx:CreateSignatureResponse result = check pricefxClient->sendDocumentToSign(typedId, payload);

undoCompensationPlanRevocation

Undo Compensation Plan Revocation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->undoCompensationPlanRevocation(typedId);

undoCompensationRecordRevocation

Undo Compensation Record Revocation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->undoCompensationRecordRevocation(typedId);

updateCompensationRecord

Update a Compensation Record

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCompensationRecordRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCompensationRecordResponse|error

Sample code:

pricefx:UpdateCompensationRecordResponse result = check pricefxClient->updateCompensationRecord(payload);

updateCompensationType

Update a Compensation Type

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCompensationTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCompensationTypeEnvelope|error

Sample code:

pricefx:UpdateCompensationTypeEnvelope result = check pricefxClient->updateCompensationType(payload);

updateConditionType

Update a Condition Type

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateConditionTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateConditionTypeEnvelope|error

Sample code:

pricefx:UpdateConditionTypeEnvelope result = check pricefxClient->updateConditionType(payload);

updateQuoteContractRebateAgreement

Update a Quote/Contract/Rebate Agreement/Compensation Plan

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Compensation Plan you want to update
payload	pricefx:ClicmanagerUpdatetypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateClicEnvelope|error

Sample code:

pricefx:UpdateClicEnvelope result = check pricefxClient->updateQuoteContractRebateAgreement(typedId, payload);

upsertCompensationPlan

Upsert a Compensation Plan

Parameters:

Name	Type	Required	Description
payload	pricefx:UpsertCompensationPlanRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpsertCompensationPlanResponse|error

Sample code:

pricefx:UpsertCompensationPlanResponse result = check pricefxClient->upsertCompensationPlan(payload);

Claims

addClaim

Add a Claim

Parameters:

Name	Type	Required	Description
payload	pricefx:AddClaimRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddClaimResponse|error

Sample code:

pricefx:AddClaimResponse result = check pricefxClient->addClaim(payload);

calculateClaim

Calculate a Claim

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the claim whose items you want to calculate
payload	pricefx:CalculateClaimRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CalculateClaimResponse|error

Sample code:

pricefx:CalculateClaimResponse result = check pricefxClient->calculateClaim(typedId, payload);

cancelClaimCalculation

Cancel a Calculation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the claim whose item calculation you want to cancel
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CancelClaimCalculationResponse|error

Sample code:

pricefx:CancelClaimCalculationResponse result = check pricefxClient->cancelClaimCalculation(typedId, payload);

getSummary

Get a Summary

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetClaimItemsSummaryResponse|error

Sample code:

pricefx:GetClaimItemsSummaryResponse result = check pricefxClient->getSummary(typedId, payload);

listClaims

List Claims + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:ListClaimsRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListClaimsResponse|error

Sample code:

pricefx:ListClaimsResponse result = check pricefxClient->listClaims(payload);

listItems

List Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListClaimItemsResponse|error

Sample code:

pricefx:ListClaimItemsResponse result = check pricefxClient->listItems(typedId, payload);

rejectItems

Reject Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Claim whose items you want to reject
payload	pricefx:RejectClaimItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RejectClaimItemsResponse|error

Sample code:

pricefx:RejectClaimItemsResponse result = check pricefxClient->rejectItems(typedId, payload);

removeItems

Remove Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Claim whose items you want to remove
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RemoveClaimItemsResponse|error

Sample code:

pricefx:RemoveClaimItemsResponse result = check pricefxClient->removeItems(typedId, payload);

submitClaim

Submit a Claim

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Claim you want to submit
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitClaimResponse|error

Sample code:

pricefx:SubmitClaimResponse result = check pricefxClient->submitClaim(typedId, payload);

updateClaim

Update a Claim + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateClaimRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateClaimResponse|error

Sample code:

pricefx:UpdateClaimResponse result = check pricefxClient->updateClaim(payload);

validateItems

Validate Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Claim whose items you want to validate
payload	pricefx:ValidateClaimItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ValidateClaimItemsResponse|error

Sample code:

pricefx:ValidateClaimItemsResponse result = check pricefxClient->validateItems(typedId, payload);

Claim Types

addClaimType

Add a Claim Type

Parameters:

Name	Type	Required	Description
payload	pricefx:AddClaimTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddClaimTypeResponse|error

Sample code:

pricefx:AddClaimTypeResponse result = check pricefxClient->addClaimType(payload);

deleteClaimType

Delete a Claim Type

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteClaimTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteClaimTypeResponse|error

Sample code:

pricefx:DeleteClaimTypeResponse result = check pricefxClient->deleteClaimType(payload);

listClaimTypes

List Claim Types

Parameters:

Name	Type	Required	Description
payload	pricefx:ListClaimTypesRequest	Yes	The example of the request body contains the filter. The call returns Claim Types whose name equals to "claimType"
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListClaimTypesResponse|error

Sample code:

pricefx:ListClaimTypesResponse result = check pricefxClient->listClaimTypes(payload);

updateClaimType

Update a Claim Type

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateClaimTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateClaimTypeResponse|error

Sample code:

pricefx:UpdateClaimTypeResponse result = check pricefxClient->updateClaimType(payload);

Attachments

checkFileExists

Check a File

Parameters:

Name	Type	Required	Description
binaryDataId	string	Yes	If the typedId is, for example, 1145.BD then the binaryDataId is 1145
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CheckFileExistsEnvelope|error

Sample code:

pricefx:CheckFileExistsEnvelope result = check pricefxClient->checkFileExists(binaryDataId);

createUploadSlot

1. Create an Upload Slot

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:CreateUploadSlotQueries	Yes	Queries to be sent with the request

Returns: pricefx:CreateUploadSlotEnvelope|error

Sample code:

pricefx:CreateUploadSlotEnvelope result = check pricefxClient->createUploadSlot(queries);

deleteFile

Delete a File

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the document whose attachment you want to delete
binaryDataId	string	Yes	If the typedId is, for example, 1145.BD then the binaryDataId is 1145
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->deleteFile(typedId, binaryDataId, payload);

deleteUploadSlot

3. Delete an Upload Slot

Parameters:

Name	Type	Required	Description
slotId	string	Yes	Enter the ID of the slot you want to delete
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UploadSlotOperationEnvelope|error

Sample code:

pricefx:UploadSlotOperationEnvelope result = check pricefxClient->deleteUploadSlot(slotId);

downloadAttachmentData

Download an Attachment

Parameters:

Name	Type	Required	Description
binaryDataId	string	Yes	If the typedId is, for example, 1146.BD then the binaryDataId is 1146
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:DownloadAttachmentDataQueries	Yes	Queries to be sent with the request

Returns: byte[]|error

Sample code:

byte[] result = check pricefxClient->downloadAttachmentData(binaryDataId, queries);

downloadFile

Download a File

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the document you want to download the attachment from
binaryDataId	string	Yes	If the typedId is, for example, 1145.BD then the binaryDataId is 1145
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:DownloadFileQueries	Yes	Queries to be sent with the request

Returns: pricefx:FileDownloadEnvelope|error

Sample code:

pricefx:FileDownloadEnvelope result = check pricefxClient->downloadFile(typedId, binaryDataId, queries);

downloadFileViaPost

Download a File

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the document you want to download the attachment from
binaryDataId	string	Yes	If the typedId is, for example, 1145.BD then the binaryDataId is 1145
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:DownloadFileViaPostQueries	Yes	Queries to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->downloadFileViaPost(typedId, binaryDataId, queries);

editAttachment

2. Upload a File

Parameters:

Name	Type	Required	Description
ownerTypedId	string	Yes	The TypedId of the document owning the attachment
binaryDataId	string	Yes	The binaryDataId of the attachment to replace
slotId	string	Yes	The upload slot_id containing the new file
payload	pricefx:BinaryDataIdslotIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:FileDownloadEnvelope|error

Sample code:

pricefx:FileDownloadEnvelope result = check pricefxClient->editAttachment(ownerTypedId, binaryDataId, slotId, payload);

getUploadProgress

Get Upload Progress

Parameters:

Name	Type	Required	Description
uploadslot	string	Yes	Upload Slot Id
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UploadSlotOperationEnvelope|error

Sample code:

pricefx:UploadSlotOperationEnvelope result = check pricefxClient->getUploadProgress(uploadslot);

listFiles

List Files

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the document you want to list attachments for
payload	pricefx:BdmanagerListtypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListFilesEnvelope|error

Sample code:

pricefx:ListFilesEnvelope result = check pricefxClient->listFiles(typedId, payload);

updateFile

Update a File

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the document whose attachment's metadata you want to update
payload	pricefx:BdmanagerUpdatetypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateFileEnvelope|error

Sample code:

pricefx:UpdateFileEnvelope result = check pricefxClient->updateFile(typedId, payload);

uploadFile

2. Upload a File

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the document you want to attach the file to
slotId	string	Yes	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	pricefx:TypedIdslotIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:FileOperationEnvelope|error

Sample code:

pricefx:FileOperationEnvelope result = check pricefxClient->uploadFile(typedId, slotId, payload);

Comments

addComment

Add a Comment

Parameters:

Name	Type	Required	Description
payload	pricefx:CommentmanagerAddBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CommentOperationEnvelope|error

Sample code:

pricefx:CommentOperationEnvelope result = check pricefxClient->addComment(payload);

deleteComment

Delete a Comment

Parameters:

Name	Type	Required	Description
typedId	string	Yes	Comment or CommentThread typedId
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCommentEnvelope|error

Sample code:

pricefx:DeleteCommentEnvelope result = check pricefxClient->deleteComment(typedId);

editComment

Edit a Comment

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the comment you want to edit
payload	pricefx:CommentmanagerEdittypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CommentOperationEnvelope|error

Sample code:

pricefx:CommentOperationEnvelope result = check pricefxClient->editComment(typedId, payload);

listCommentThreads

List Comment Threads

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the object you want to fetch comments for
payload	pricefx:CommentmanagerFetchthreadstypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ListCommentThreadsQueries	Yes	Queries to be sent with the request

Returns: pricefx:ListCommentThreadsEnvelope|error

Sample code:

pricefx:ListCommentThreadsEnvelope result = check pricefxClient->listCommentThreads(typedId, payload, queries);

replyToComment

Reply To a Comment

Parameters:

Name	Type	Required	Description
payload	pricefx:CommentmanagerReplyBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CommentOperationEnvelope|error

Sample code:

pricefx:CommentOperationEnvelope result = check pricefxClient->replyToComment(payload);

resolveComment

Resolve a Comment

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the comment thread
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ResolveCommentEnvelope|error

Sample code:

pricefx:ResolveCommentEnvelope result = check pricefxClient->resolveComment(typedId, payload);

unresolveComment

Unresolve a Comment

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the comment thread
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ResolveCommentEnvelope|error

Sample code:

pricefx:ResolveCommentEnvelope result = check pricefxClient->unresolveComment(typedId, payload);

Custom Forms

changeCustomFormStatus

Change a Custom Form Status

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Custom Form whose status you want to change
payload	pricefx:ChangeCustomFormStatusRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ChangeCustomFormStatusResponse|error

Sample code:

pricefx:ChangeCustomFormStatusResponse result = check pricefxClient->changeCustomFormStatus(typedId, payload);

createCustomForm

Create a Custom Form + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:CreateCustomFormRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CreateCustomFormEnvelope|error

Sample code:

pricefx:CreateCustomFormEnvelope result = check pricefxClient->createCustomForm(payload);

createCustomFormRevision

Create a Custom Form Revision

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Custom Form you want to create a revision from
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CustomFormRevisionEnvelope|error

Sample code:

pricefx:CustomFormRevisionEnvelope result = check pricefxClient->createCustomFormRevision(typedId, payload);

createCustomFormType

Create a Custom Form Type

Parameters:

Name	Type	Required	Description
payload	pricefx:CreateCustomFormTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CreateCustomFormTypeResponse|error

Sample code:

pricefx:CreateCustomFormTypeResponse result = check pricefxClient->createCustomFormType(payload);

deleteCustomForm

Delete a Custom Form

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCustomFormRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->deleteCustomForm(payload);

deleteCustomFormType

Delete a Custom Form Type

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCFOTBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCustomFormTypeEnvelope|error

Sample code:

pricefx:DeleteCustomFormTypeEnvelope result = check pricefxClient->deleteCustomFormType(payload);

duplicateCustomForm

Duplicate a Custom Form

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Custom Form you want to duplicate
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CustomFormRevisionEnvelope|error

Sample code:

pricefx:CustomFormRevisionEnvelope result = check pricefxClient->duplicateCustomForm(typedId, payload);

getCustomForm

Get a Custom Form

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Custom Form you want to retrieve details for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetCustomFormResponse|error

Sample code:

pricefx:GetCustomFormResponse result = check pricefxClient->getCustomForm(typedId);

listCustomFormTypes

List Custom Form Types

Parameters:

Name	Type	Required	Description
payload	pricefx:ListCustomFormTypesRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCustomFormTypesResponse|error

Sample code:

pricefx:ListCustomFormTypesResponse result = check pricefxClient->listCustomFormTypes(payload);

listCustomForms

List Custom Forms

Parameters:

Name	Type	Required	Description
payload	pricefx:ListCustomFormsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCustomFormsEnvelope|error

Sample code:

pricefx:ListCustomFormsEnvelope result = check pricefxClient->listCustomForms(payload);

previewCustomFormWorkflow

Preview a Custom Form Workflow

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:PreviewCustomFormWorkflowResponse|error

Sample code:

pricefx:PreviewCustomFormWorkflowResponse result = check pricefxClient->previewCustomFormWorkflow(payload);

updateCustomForm

Update a Custom Form

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCustomFormRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCustomFormEnvelope|error

Sample code:

pricefx:UpdateCustomFormEnvelope result = check pricefxClient->updateCustomForm(payload);

updateCustomFormType

Update a Custom Form Type

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCustomFormTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCustomFormTypeResponse|error

Sample code:

pricefx:UpdateCustomFormTypeResponse result = check pricefxClient->updateCustomFormType(payload);

Data Change Requests

addDataChangeRequest

Add a Data Change Request

Parameters:

Name	Type	Required	Description
payload	pricefx:AddDCRRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddDCRResponse|error

Sample code:

pricefx:AddDCRResponse result = check pricefxClient->addDataChangeRequest(payload);

addDataChangeRequestItem

Add a Data Change Request Item

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request you want to add the Data Change Request Item to
payload	pricefx:AddDCRIRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddDCRIResponse|error

Sample code:

pricefx:AddDCRIResponse result = check pricefxClient->addDataChangeRequestItem(id, payload);

deleteDataChangeRequestItem

Delete a Data Change Request Item

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request whose item you want to delete
payload	pricefx:DeleteDCRIRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteDCRIResponse|error

Sample code:

pricefx:DeleteDCRIResponse result = check pricefxClient->deleteDataChangeRequestItem(id, payload);

deleteDataChangeRequestMassChange

Delete a Data Change Request Mass Change

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request
payload	pricefx:DcrmanagerDeletemassopidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DataChangeRequestMassChangeEnvelope|error

Sample code:

pricefx:DataChangeRequestMassChangeEnvelope result = check pricefxClient->deleteDataChangeRequestMassChange(id, payload);

getDataChangeRequest

Get a Data Change Request

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request you want to retrieve
payload	pricefx:GetDCRRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetDCRResponse|error

Sample code:

pricefx:GetDCRResponse result = check pricefxClient->getDataChangeRequest(id, payload);

getDataChangeRequestChanges

Get a Data Change Request (changes only)

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request you want to retrieve changed items for
payload	pricefx:GetDCRRequestChangeOnly	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetDCRResponseChangeOnly|error

Sample code:

pricefx:GetDCRResponseChangeOnly result = check pricefxClient->getDataChangeRequestChanges(id, payload);

getDataChangeRequestMassChanges

Get Data Change Request Mass Changes

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request
payload	pricefx:DcrmanagerFetchmassopidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DataChangeRequestMassChangeEnvelope|error

Sample code:

pricefx:DataChangeRequestMassChangeEnvelope result = check pricefxClient->getDataChangeRequestMassChanges(id, payload);

massEditDataChangeRequestItems

Mass Edit Data Change Request Items

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request
payload	pricefx:DcrmanagerAddmassopidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DataChangeRequestMassChangeEnvelope|error

Sample code:

pricefx:DataChangeRequestMassChangeEnvelope result = check pricefxClient->massEditDataChangeRequestItems(id, payload);

submitDataChangeRequest

Submit a Data Change Request

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the DCR to be submitted
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitDCRResponse|error

Sample code:

pricefx:SubmitDCRResponse result = check pricefxClient->submitDataChangeRequest(id, payload);

submitDataChangeRequestAsync

Submit a Data Change Request (async)

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the DCR to be submitted
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitDCRAsyncResponse|error

Sample code:

pricefx:SubmitDCRAsyncResponse result = check pricefxClient->submitDataChangeRequestAsync(id, payload);

updateDataChangeRequestItem

Update a Data Change Request Item

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request whose item you want to update
payload	pricefx:UpdateDCRIRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateDCRIResponse|error

Sample code:

pricefx:UpdateDCRIResponse result = check pricefxClient->updateDataChangeRequestItem(id, payload);

updateDataChangeRequestMassChanges

Update Data Change Request Mass Changes

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Data Change Request
payload	pricefx:DcrmanagerUpdatemassopidBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DataChangeRequestMassChangeEnvelope|error

Sample code:

pricefx:DataChangeRequestMassChangeEnvelope result = check pricefxClient->updateDataChangeRequestMassChanges(id, payload);

Data Manager

createDMFieldCollection

Create a DMFieldCollection

Parameters:

Name	Type	Required	Description
fcType	"DMDS"|"DMT"	Yes	The type of FC (FieldCollection) you want to create
payload	pricefx:DatamartCreatefcfcTypeBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->createDMFieldCollection(fcType, payload);

createDataManagerEntity

Create a Data Manager Entity

Parameters:

Name	Type	Required	Description
typeCode	"DMF"|"DM"|"DMDS"	Yes	The type code of the Field Collection you want to update
payload	pricefx:CreateDataManagerEntityRequest	Yes	Either uniqueName or typedId must be provided in the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DmObjectResponse|error

Sample code:

pricefx:DmObjectResponse result = check pricefxClient->createDataManagerEntity(typeCode, payload);

deleteDataManagerEntity

Delete a Data Manager Entity

Parameters:

Name	Type	Required	Description
typeCode	"DM"|"DMF"|"DMDS"	Yes	The type code of the Field Collection you want to delete
payload	pricefx:DeleteDataManagerEntityRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteDataManagerEntityResponse|error

Sample code:

pricefx:DeleteDataManagerEntityResponse result = check pricefxClient->deleteDataManagerEntity(typeCode, payload);

deleteDatamartOrphanObjects

Delete Datamart Orphan Objects

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DatamartOrphanObjectsEnvelope|error

Sample code:

pricefx:DatamartOrphanObjectsEnvelope result = check pricefxClient->deleteDatamartOrphanObjects();

executeDataLoadLogic

Execute a Data Load Logic

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Data Load you want to evaluate
logicName	string	Yes	The name of the logic you want to execute
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ExecuteDataLoadLogicResponse|error

Sample code:

pricefx:ExecuteDataLoadLogicResponse result = check pricefxClient->executeDataLoadLogic(typedId, logicName);

exportCsvFile

Export a CSV File

Parameters:

Name	Type	Required	Description
payload	pricefx:ExportCSVFileRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ExportCsvFileQueries	Yes	Queries to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->exportCsvFile(payload, queries);

exportDatamart

Export Datamart

Parameters:

Name	Type	Required	Description
fcTypedIdOrSourceName	string	Yes	Restricts the export to a specific source, identified by either the 'typedId' or 'sourceName'.
payload	pricefx:ExportDatamartRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ExportDatamartQueries	Yes	Queries to be sent with the request

Returns: pricefx:ExportDatamartResponse|error

Sample code:

pricefx:ExportDatamartResponse result = check pricefxClient->exportDatamart(fcTypedIdOrSourceName, payload, queries);

exportExcelFileXlsx

Export an Excel File (XLSX)

Parameters:

Name	Type	Required	Description
payload	pricefx:ExportExcelFileRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ExportExcelFileXlsxQueries	Yes	Queries to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->exportExcelFileXlsx(payload, queries);

fetchDataMartObject

Get a DM Object - 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

Parameters:

Name	Type	Required	Description
objectId	string	Yes	Use one of the following object identifiers:
payload	pricefx:GetDMObjectRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:FetchDataMartObjectQueries	Yes	Queries to be sent with the request

Returns: pricefx:GetDMObjectResponse|error

Sample code:

pricefx:GetDMObjectResponse result = check pricefxClient->fetchDataMartObject(objectId, payload, queries);

getActionStatus

Get Action Status

Parameters:

Name	Type	Required	Description
actionUUID	string	Yes	The actionUUID to be sent with the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetActionStatusResponse|error

Sample code:

pricefx:GetActionStatusResponse result = check pricefxClient->getActionStatus(actionUUID);

getDataMartObject

Get a DM Object - 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

Parameters:

Name	Type	Required	Description
objectId	string	Yes	Use one of the following object identifiers:
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:GetDataMartObjectQueries	Yes	Queries to be sent with the request

Returns: pricefx:DataMartObjectEnvelope|error

Sample code:

pricefx:DataMartObjectEnvelope result = check pricefxClient->getDataMartObject(objectId, queries);

getDmExportFile

Get a DM Export File

Parameters:

Name	Type	Required	Description
fileName	string	Yes	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[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->getDmExportFile(fileName);

getDmObjectNo

Get a DM Object (no count) - 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

Parameters:

Name	Type	Required	Description
objectId	string	Yes	Use one of the following object identifiers:
payload	pricefx:GetDMObjectNoCountRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetDMObjectNoCountResponse|error

Sample code:

pricefx:GetDMObjectNoCountResponse result = check pricefxClient->getDmObjectNo(objectId, payload);

importDataLoad

Import a Data Load

Parameters:

Name	Type	Required	Description
payload	pricefx:ImportDataLoadRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->importDataLoad(payload);

importDataMartFile

Import a File

Parameters:

Name	Type	Required	Description
slotId	string	Yes	The id of the slot. Create the slot and retrieve the id using the /uploadmanager.newuploadslot endpoint
typedId	string	Yes	The typedId of the Data Manager entity
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->importDataMartFile(slotId, typedId);

listCharts

List Charts

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListChartsResponse|error

Sample code:

pricefx:ListChartsResponse result = check pricefxClient->listCharts();

listDataLoads

List Data Loads

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListDataLoadsResponse|error

Sample code:

pricefx:ListDataLoadsResponse result = check pricefxClient->listDataLoads();

listDataLoadsWith

List Data Loads (with validation and schedules)

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListDataLoadsWithValidationResponse|error

Sample code:

pricefx:ListDataLoadsWithValidationResponse result = check pricefxClient->listDataLoadsWith();

listDataManagerEntities

List Data Manager Entities

Parameters:

Name	Type	Required	Description
typeCode	"DM"|"DMDS"|"DMF"|"DMT"	Yes	The type code of the Field Collection
payload	pricefx:ListDataManagerEntitiesRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DmObjectResponse|error

Sample code:

pricefx:DmObjectResponse result = check pricefxClient->listDataManagerEntities(typeCode, payload);

listDatamartOrphanObjects

List Datamart Orphan Objects

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DatamartOrphanObjectsEnvelope|error

Sample code:

pricefx:DatamartOrphanObjectsEnvelope result = check pricefxClient->listDatamartOrphanObjects();

listRollups

List Rollups

Parameters:

Name	Type	Required	Description
payload	pricefx:ListRollupsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListRollupsResponse|error

Sample code:

pricefx:ListRollupsResponse result = check pricefxClient->listRollups(payload);

massEditDataMartObject

Mass Edit

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the object you want to perform the mass edit action for
payload	pricefx:MassEditRequest1	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassEditDatamartResponse|error

Sample code:

pricefx:MassEditDatamartResponse result = check pricefxClient->massEditDataMartObject(typedId, payload);

queryDataManagerObject

Query a Data Manager Object

Parameters:

Name	Type	Required	Description
payload	pricefx:QueryDataManagerObjectRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:QueryDataManagerObjectQueries	Yes	Queries to be sent with the request

Returns: pricefx:QueryDataManagerObjectResponse|error

Sample code:

pricefx:QueryDataManagerObjectResponse result = check pricefxClient->queryDataManagerObject(payload, queries);

restoreDefaultDataSources

Restore Default Data Sources

Parameters:

Name	Type	Required	Description
dataSourceName	"Product"|"Customer"|"uom"|"ccy"|"cal"	Yes	The name of the Data Source you want to create.
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RestoreDefaultDataSourcesResponse|error

Sample code:

pricefx:RestoreDefaultDataSourcesResponse result = check pricefxClient->restoreDefaultDataSources(dataSourceName);

runDataLoad

Run a Data Load

Parameters:

Name	Type	Required	Description
payload	pricefx:RunDataLoadRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RunDataLoadResponse|error

Sample code:

pricefx:RunDataLoadResponse result = check pricefxClient->runDataLoad(payload);

saveDataLoad

Save a Data Load

Parameters:

Name	Type	Required	Description
payload	pricefx:DatamartUpdatedataloadBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DataLoadEnvelope|error

Sample code:

pricefx:DataLoadEnvelope result = check pricefxClient->saveDataLoad(payload);

sqlQueryDataManagerObject

SQL Query a Data Manager Object

Parameters:

Name	Type	Required	Description
payload	pricefx:DatamartSqlqueryBody	Yes	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[]>	No	Headers to be sent with the request
queries	*pricefx:SqlQueryDataManagerObjectQueries	Yes	Queries to be sent with the request

Returns: pricefx:QueryDataManagerObjectResponse|error

Sample code:

pricefx:QueryDataManagerObjectResponse result = check pricefxClient->sqlQueryDataManagerObject(payload, queries);

updateDataManagerEntity

Update a Data Manager Entity

Parameters:

Name	Type	Required	Description
typeCode	"DMF"|"DM"|"DMDS"	Yes	The type code of the Field Collection you want to update
payload	pricefx:UpdateDataManagerEntityRequest	Yes	Either uniqueName or typedId must be provided in the request
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DmObjectResponse|error

Sample code:

pricefx:DmObjectResponse result = check pricefxClient->updateDataManagerEntity(typeCode, payload);

uploadBulkDataToDataSource

Upload a Bulk Data to Data Source

Parameters:

Name	Type	Required	Description
datasourceUniqueName	string	Yes	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	pricefx:UploadBulkDataToDataSourceRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:BulkDataUploadEnvelope|error

Sample code:

pricefx:BulkDataUploadEnvelope result = check pricefxClient->uploadBulkDataToDataSource(datasourceUniqueName, payload);

Imports

deleteImportChanges

Delete Import Changes

Parameters:

Name	Type	Required	Description
payload	pricefx:ImportmanagerDeletechangesBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->deleteImportChanges(payload);

listImportManagerChanges

List ImportManager Changes

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The uniqueName to be sent with the request
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListImportManagerChangesEnvelope|error

Sample code:

pricefx:ListImportManagerChangesEnvelope result = check pricefxClient->listImportManagerChanges(uniqueName, payload);

massDeleteImports

Mass Delete Imports

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	pricefx:ImportmanagerMassdeletetypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassDeleteImportsEnvelope|error

Sample code:

pricefx:MassDeleteImportsEnvelope result = check pricefxClient->massDeleteImports(typedId, payload);

massEditImports

Mass Edit Imports

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	pricefx:ImportmanagerMassedittypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassEditImportsEnvelope|error

Sample code:

pricefx:MassEditImportsEnvelope result = check pricefxClient->massEditImports(typedId, payload);

saveImportChange

Save Import Change

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SaveImportChangeEnvelope|error

Sample code:

pricefx:SaveImportChangeEnvelope result = check pricefxClient->saveImportChange(payload);

submitChanges

Submit Changes

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the import
payload	pricefx:ImportmanagerSubmittypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ImportManagerUploadEnvelope|error

Sample code:

pricefx:ImportManagerUploadEnvelope result = check pricefxClient->submitChanges(typedId, payload);

uploadExcelToImportManager

Upload Excel to Import Manager

Parameters:

Name	Type	Required	Description
typeCode	"P"|"PX"	Yes	Target object type code
target	string	Yes	Provides additional details about the target object, such as specifying a PX name if required
slotId	string	Yes	ID of the Upload Slot
payload	pricefx:TypeCodetargetBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:UploadExcelToImportManagerQueries	Yes	Queries to be sent with the request

Returns: pricefx:ImportManagerUploadEnvelope|error

Sample code:

pricefx:ImportManagerUploadEnvelope result = check pricefxClient->uploadExcelToImportManager(typeCode, target, slotId, payload, queries);

Lookup Tables / Company Parameters

addLookupTable

Add a Lookup Table

Parameters:

Name	Type	Required	Description
payload	pricefx:AddLookupTableRequest	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:AddLookupTableResponse|error

Sample code:

pricefx:AddLookupTableResponse result = check pricefxClient->addLookupTable(payload);

addLookupTableValue

Add a Lookup Table Value

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method
payload	pricefx:AddLookupTableValueRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddLookupTableValueResponse|error

Sample code:

pricefx:AddLookupTableValueResponse result = check pricefxClient->addLookupTableValue(tableId, payload);

copyLookupTable

Copy a Lookup Table

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table you want to copy
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CopyLookupTableResponse|error

Sample code:

pricefx:CopyLookupTableResponse result = check pricefxClient->copyLookupTable(tableId);

deleteColumnValuesMatrix

Delete Column Values (Matrix only)

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method
columnName	string	Yes	Enter the name of the column you want to delete values from
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->deleteColumnValuesMatrix(tableId, columnName);

deleteLookupTable

Delete a Lookup Table

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteLookupTableRequest	Yes	Specify the typedId of the Lookup Table (Company Parameters) you want to delete
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteLookupTableResponse|error

Sample code:

pricefx:DeleteLookupTableResponse result = check pricefxClient->deleteLookupTable(payload);

deleteLookupTableValue

Delete a Lookup Table Value + payload -

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method
payload	pricefx:DeleteLookupTableValueRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteLookupTableValueResponse|error

Sample code:

pricefx:DeleteLookupTableValueResponse result = check pricefxClient->deleteLookupTableValue(tableId, payload);

getLogicReferences

Get Logic References

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table you want to retrieve logic references for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetLogicReferencesResponse|error

Sample code:

pricefx:GetLogicReferencesResponse result = check pricefxClient->getLogicReferences(tableId);

insertBulkDataToLookupTable

Insert Bulk Data to Lookup Table

Parameters:

Name	Type	Required	Description
typeCode	"JLTV"|"JLTVM"|"LT"|"LTT"|"LTV"|"MLTV"|"MLTV2"|"MLTV3"|"MLTV4"|"MLTV5"|"MLTV6"|"MLTVM"	Yes	Enter the type code of the Lookup Table entity you want to insert a data to
payload	pricefx:InsertBulkDataToLookupTableRequest	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:InsertBulkDataLookupTableResponse|error

Sample code:

pricefx:InsertBulkDataLookupTableResponse result = check pricefxClient->insertBulkDataToLookupTable(typeCode, payload);

listAllLookupTableValues

List All Lookup Table Values

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method
payload	pricefx:ListAllLookupTableValuesRequest	Yes	You can specify the start and end row to limit the number of retrieved records
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ListAllLookupTableValuesQueries	Yes	Queries to be sent with the request

Returns: pricefx:ListAllLookupTableValuesResponse|error

Sample code:

pricefx:ListAllLookupTableValuesResponse result = check pricefxClient->listAllLookupTableValues(tableId, payload, queries);

listAllLookupTables

List All Lookup Tables

Parameters:

Name	Type	Required	Description
payload	pricefx:ListAllLookupTablesRequest	Yes	You can specify the start and end row to limit the number of retrieved Lookup Tables / Company Parameters
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListAllLookupTablesResponse|error

Sample code:

pricefx:ListAllLookupTablesResponse result = check pricefxClient->listAllLookupTables(payload);

massDeleteLookupTableValues

Mass Delete Lookup Table Values + payload -

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method
payload	pricefx:TableIdBatchBody	Yes
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:MassDeleteLookupTableValuesQueries	Yes	Queries to be sent with the request

Returns: pricefx:DeleteLookupTableValueResponse1|error

Sample code:

pricefx:DeleteLookupTableValueResponse1 result = check pricefxClient->massDeleteLookupTableValues(tableId, payload, queries);

massEditLookupTable

Mass Edit

Parameters:

Name	Type	Required	Description
tableId	string	Yes	The ID of the Lookup Table whose values you want to update
payload	pricefx:MassEditRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassEditResponse|error

Sample code:

pricefx:MassEditResponse result = check pricefxClient->massEditLookupTable(tableId, payload);

updateLookupTable

Update a Lookup Table + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateLookupTableRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateLookupTableResponse|error

Sample code:

pricefx:UpdateLookupTableResponse result = check pricefxClient->updateLookupTable(payload);

updateLookupTableValue

Update a Lookup Table Value

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method
payload	pricefx:UpdateLookupTableValueRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateLookupTableValueResponse|error

Sample code:

pricefx:UpdateLookupTableValueResponse result = check pricefxClient->updateLookupTableValue(tableId, payload);

upsertLookupTableValue

Upsert a Lookup Table Value

Parameters:

Name	Type	Required	Description
tableId	string	Yes	Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method
payload	pricefx:UpsertLookupTableValueRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpsertLookupTableValueResponse|error

Sample code:

pricefx:UpsertLookupTableValueResponse result = check pricefxClient->upsertLookupTableValue(tableId, payload);

Key-Value Store

countKeys

Count Keys

Parameters:

Name	Type	Required	Description
tableName	string	Yes	The table to count keys from
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->countKeys(tableName);

createKvTable

Create a KV Table

Parameters:

Name	Type	Required	Description
tableName	string	Yes	A name of the table you want create. Only lower case letters, numbers and underscores are allowed. Do not use special characters
payload	pricefx:CreateKVTableRequest	Yes	The sample request creates a table with four columns: sku, customer, record and payload (TEXT).<br>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->createKvTable(tableName, payload);

deleteKey

Delete a Key

Parameters:

Name	Type	Required	Description
tableName	string	Yes	The tableName to be sent with the request
payload	pricefx:DeleteKVKeyRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->deleteKey(tableName, payload);

dropKvTable

Drop a KV Table

Parameters:

Name	Type	Required	Description
tableName	string	Yes	A name of the table you want drop. Only lower case letters, numbers and underscores are allowed. Do not use special characters
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: record

Sample code:

record result = check pricefxClient->dropKvTable(tableName, payload);

getKey

Get a Key

Parameters:

Name	Type	Required	Description
tableName	string	Yes	A name of the table you want to retrieve the "payload" from
payload	pricefx:GetKVKeyRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->getKey(tableName, payload);

getTableInfo

Get a Table Info

Parameters:

Name	Type	Required	Description
tableName	string	Yes	A name of the table you want to retrieve information about
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetKVTableInfoResponse|error

Sample code:

pricefx:GetKVTableInfoResponse result = check pricefxClient->getTableInfo(tableName);

insertBulkKvData

Insert Bulk KV Data

Parameters:

Name	Type	Required	Description
tableName	string	Yes	A name of the table you want upload data to
payload	pricefx:InsertBulkKVDataRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->insertBulkKvData(tableName, payload);

listKvTables

List KV Tables

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListKVTablesResponse|error

Sample code:

pricefx:ListKVTablesResponse result = check pricefxClient->listKvTables();

searchKvTable

Search a KV Table + payload -

Parameters:

Name	Type	Required	Description
tableName	string	Yes	A name of the table you want to search the pattern for
payload	pricefx:SearchKVTableRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SearchKvTableEnvelope[]|error

Sample code:

pricefx:SearchKvTableEnvelope[] result = check pricefxClient->searchKvTable(tableName, payload);

truncateTable

Truncate a Table

Parameters:

Name	Type	Required	Description
tableName	string	Yes	The table you want to remove the keys from
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:TruncateKVTableResponse|error

Sample code:

pricefx:TruncateKVTableResponse result = check pricefxClient->truncateTable(tableName);

upsertKey

Upsert a Key + payload -

Parameters:

Name	Type	Required	Description
tableName	string	Yes	A name of the table you want to upsert the key into
payload	pricefx:UpsertKVKeyRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpsertKVKeyResponse|error

Sample code:

pricefx:UpsertKVKeyResponse result = check pricefxClient->upsertKey(tableName, payload);

Logics

copyLogic

Copy a Logic

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:CopyLogicResponse|error

Sample code:

pricefx:CopyLogicResponse result = check pricefxClient->copyLogic(id);

deleteLogic

Delete a Logic

Parameters:

Name	Type	Required	Description
id	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteLogicResponse|error

Sample code:

pricefx:DeleteLogicResponse result = check pricefxClient->deleteLogic(id);

executeLibraryFunction

Execute Library Function

Parameters:

Name	Type	Required	Description
formulaName	string	Yes	Name of the formula library containing the function
elementName	string	Yes	Name of the library element containing the function
functionName	string	Yes	Name of the function to execute
payload	pricefx:ElementNamefunctionNameBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->executeLibraryFunction(formulaName, elementName, functionName, payload);

executeLogicInService

Execute a Logic Without a Context in a Service + payload -

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The name (uniqueName) of the logic you want to execute
payload	record {record {} data?;}	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LogicResponse|error

Sample code:

pricefx:LogicResponse result = check pricefxClient->executeLogicInService(uniqueName, payload);

executeLogicInServiceReadOnly

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

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The name (uniqueName) of the logic you want to execute
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ExecuteLogicReadOnlyResponse|error

Sample code:

pricefx:ExecuteLogicReadOnlyResponse result = check pricefxClient->executeLogicInServiceReadOnly(uniqueName);

executeLogicRead

Execute a Logic (Read-Only)

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The name (uniqueName) of the logic you want to execute
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ExecuteLogicReadOnlyResponse|error

Sample code:

pricefx:ExecuteLogicReadOnlyResponse result = check pricefxClient->executeLogicRead(uniqueName);

executeLogicWithout

Execute a Logic (Without a Context) + payload -

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The name (uniqueName) of the logic you want to execute
payload	record {record {} data?;}	Yes
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ExecuteLogicWithoutQueries	Yes	Queries to be sent with the request

Returns: pricefx:ExecuteLogicWithoutProductContextResponse|error

Sample code:

pricefx:ExecuteLogicWithoutProductContextResponse result = check pricefxClient->executeLogicWithout(uniqueName, payload, queries);

executeNamedProductLogic

Execute a Logic + payload -

Parameters:

Name	Type	Required	Description
sku	string	Yes	The sku or typedId of the product you want to execute the assigned logic for
uniqueName	string	Yes	The name (uniqueName) of the logic you want to execute
payload	record {record {} data?;}	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ExecuteLogicResponse|error

Sample code:

pricefx:ExecuteLogicResponse result = check pricefxClient->executeNamedProductLogic(sku, uniqueName, payload);

executeProductLogic

Execute an Assigned Logic + payload -

Parameters:

Name	Type	Required	Description
sku	string	Yes	The sku or typedId of the product you want to execute the logic for
payload	record {record {} data?;}	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ExecuteAssignedLogicResponse|error

Sample code:

pricefx:ExecuteAssignedLogicResponse result = check pricefxClient->executeProductLogic(sku, payload);

generateParameters

Generate Parameters

Parameters:

Name	Type	Required	Description
payload	pricefx:GenerateParametersRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenerateParametersResponse|error

Sample code:

pricefx:GenerateParametersResponse result = check pricefxClient->generateParameters(payload);

getDefaultPricingLogicName

Get a Default Pricing Logic Name

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetDefaultPricingLogicNameResponse|error

Sample code:

pricefx:GetDefaultPricingLogicNameResponse result = check pricefxClient->getDefaultPricingLogicName();

getLogic

Get a Logic

Parameters:

Name	Type	Required	Description
id	string	Yes	The ID of the logic you want to retrieve details for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetLogicResponse|error

Sample code:

pricefx:GetLogicResponse result = check pricefxClient->getLogic(id);

listElements

List Elements

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The name (uniqueName) of the logic you want to list elements for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListElementsResponse|error

Sample code:

pricefx:ListElementsResponse result = check pricefxClient->listElements(uniqueName);

listFunctions

List Functions

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListFunctionsResponse|error

Sample code:

pricefx:ListFunctionsResponse result = check pricefxClient->listFunctions();

listLibraries

List Libraries

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListLibrariesResponse|error

Sample code:

pricefx:ListLibrariesResponse result = check pricefxClient->listLibraries();

listLogicParametersInput

List Logic Parameters (Input Fields)

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:ListLogicInputFieldsResponse|error

Sample code:

pricefx:ListLogicInputFieldsResponse result = check pricefxClient->listLogicParametersInput(uniqueName);

listLogics

List Logics

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListLogicsResponse|error

Sample code:

pricefx:ListLogicsResponse result = check pricefxClient->listLogics();

setDefaultPricingLogic

Set a Default Pricing Logic

Parameters:

Name	Type	Required	Description
uniqueName	string	Yes	The name (uniqueName) of the logic that will be set as default. Leave blank to clear the default pricing logic
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SetDefaultPricingLogicResponse|error

Sample code:

pricefx:SetDefaultPricingLogicResponse result = check pricefxClient->setDefaultPricingLogic(uniqueName);

syntaxCheck

Syntax Check

Parameters:

Name	Type	Required	Description
payload	pricefx:SyntaxCheckRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->syntaxCheck(payload);

testLogic

Test a Logic

Parameters:

Name	Type	Required	Description
payload	pricefx:TestLogicRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:TestLogicEnvelope|error

Sample code:

pricefx:TestLogicEnvelope result = check pricefxClient->testLogic(payload);

updateLogic

Update a Logic

Parameters:

Name	Type	Required	Description
id	string	Yes	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 {record {decimal version?; string typedId?; string uniqueName?; string label?; string validAfter?; string status?; anydata simulationSet?; anydata userGroupEdit?; anydata userGroupViewDetails?; anydata formulaNature?; string lastUpdateByName?; record {decimal version?; string typedId?; string elementName?; string elementLabel?; anydata elementDescription?; string[] elementGroups?; anydata conditionElementName?; boolean hideWarnings?; boolean excludeFromExport?; boolean protectedExpression?; decimal elementTimeout?; decimal displayOptions?; string? formatType?; anydata elementSuffix?; boolean allowOverride?; boolean summarize?; boolean hideOnNull?; anydata userGroup?; anydata cssProperties?; anydata resultGroup?; string combinationType?; boolean storeInAttributeExtension?; anydata criticalAlert?; anydata redAlert?; anydata yellowAlert?; anydata labelTranslations?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?; string formulaExpression?;}[] elements?; record {}[] inputDescriptors?; string formulaType?; anydata createdByName?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?;} data?;}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LogicResponse|error

Sample code:

pricefx:LogicResponse result = check pricefxClient->updateLogic(id, payload);

updateLogicNo

Update a Logic (No syntax check)

Parameters:

Name	Type	Required	Description
id	string	Yes	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 {record {decimal version?; string typedId?; string uniqueName?; string label?; string validAfter?; string status?; anydata simulationSet?; anydata userGroupEdit?; anydata userGroupViewDetails?; anydata formulaNature?; string lastUpdateByName?; record {decimal version?; string typedId?; string elementName?; string elementLabel?; anydata elementDescription?; string[] elementGroups?; anydata conditionElementName?; boolean hideWarnings?; boolean excludeFromExport?; boolean protectedExpression?; decimal elementTimeout?; decimal displayOptions?; string? formatType?; anydata elementSuffix?; boolean allowOverride?; boolean summarize?; boolean hideOnNull?; anydata userGroup?; anydata cssProperties?; anydata resultGroup?; string combinationType?; boolean storeInAttributeExtension?; anydata criticalAlert?; anydata redAlert?; anydata yellowAlert?; anydata labelTranslations?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?; string formulaExpression?;}[] elements?; record {}[] inputDescriptors?; string formulaType?; anydata createdByName?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?;} data?;}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LogicResponse|error

Sample code:

pricefx:LogicResponse result = check pricefxClient->updateLogicNo(id, payload);

updateLogicPartial

Update a Logic (Partial)

Parameters:

Name	Type	Required	Description
id	string	Yes	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 {record {decimal version?; string typedId?; string uniqueName?; string label?; string validAfter?; string status?; anydata simulationSet?; anydata userGroupEdit?; anydata userGroupViewDetails?; anydata formulaNature?; string lastUpdateByName?; record {decimal version?; string typedId?; string elementName?; string elementLabel?; anydata elementDescription?; string[] elementGroups?; anydata conditionElementName?; boolean hideWarnings?; boolean excludeFromExport?; boolean protectedExpression?; decimal elementTimeout?; decimal displayOptions?; string? formatType?; anydata elementSuffix?; boolean allowOverride?; boolean summarize?; boolean hideOnNull?; anydata userGroup?; anydata cssProperties?; anydata resultGroup?; string combinationType?; boolean storeInAttributeExtension?; anydata criticalAlert?; anydata redAlert?; anydata yellowAlert?; anydata labelTranslations?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?; string formulaExpression?;}[] elements?; record {}[] inputDescriptors?; string formulaType?; anydata createdByName?; string createDate?; decimal createdBy?; string lastUpdateDate?; decimal lastUpdateBy?;} data?;}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LogicResponse|error

Sample code:

pricefx:LogicResponse result = check pricefxClient->updateLogicPartial(id, payload);

Calculation Grids

acceptCalculationGridItem

Submit a Calculation Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:SubmitCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitCalculationGridItemResponse|error

Sample code:

pricefx:SubmitCalculationGridItemResponse result = check pricefxClient->acceptCalculationGridItem(id, payload);

addCalculationGrid

Add a Calculation Grid

Parameters:

Name	Type	Required	Description
payload	pricefx:AddCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddCalculationGridResponse|error

Sample code:

pricefx:AddCalculationGridResponse result = check pricefxClient->addCalculationGrid(payload);

addCalculationGridItem

Add a Calculation Grid Item

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
payload	pricefx:AddCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddCalculationGridItemResponse|error

Sample code:

pricefx:AddCalculationGridItemResponse result = check pricefxClient->addCalculationGridItem(keyNumber, payload);

calculateCalculationGrid

Calculate a Calculation Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Calculation Grid you want to calculate
payload	pricefx:CalculateCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CalculateCalculationGridResponse|error

Sample code:

pricefx:CalculateCalculationGridResponse result = check pricefxClient->calculateCalculationGrid(id, payload);

deleteCalculationGrid

Delete a Calculation Grid

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCalculationGridResponse|error

Sample code:

pricefx:DeleteCalculationGridResponse result = check pricefxClient->deleteCalculationGrid(payload);

deleteCalculationGridItem

Delete a Calculation Grid Item

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
payload	pricefx:DeleteCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteCalculationGridItemResponse|error

Sample code:

pricefx:DeleteCalculationGridItemResponse result = check pricefxClient->deleteCalculationGridItem(keyNumber, payload);

getCalculationGrid

Get a Calculation Grid

Parameters:

Name	Type	Required	Description
id	string	Yes	ID of the Calculation Grid you want to retrieve
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetCalculationGridResponse|error

Sample code:

pricefx:GetCalculationGridResponse result = check pricefxClient->getCalculationGrid(id, payload);

getCalculationGridItem

Get a Calculation Grid Item

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
id	string	Yes	id of the Calculation Grid Item you want to fetch
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetCalculationGridItemResponse|error

Sample code:

pricefx:GetCalculationGridItemResponse result = check pricefxClient->getCalculationGridItem(keyNumber, id, payload);

listCalculationGridItems

List Calculation Grid Items

Parameters:

Name	Type	Required	Description
keyNumber	"1"|"2"|"3"|"4"|"5"|"6"	Yes	Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys
payload	pricefx:ListCalculationGridItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCalculationGridItemsResponse|error

Sample code:

pricefx:ListCalculationGridItemsResponse result = check pricefxClient->listCalculationGridItems(keyNumber, payload);

listCalculationGrids

List Calculation Grids

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListCalculationGridsResponse|error

Sample code:

pricefx:ListCalculationGridsResponse result = check pricefxClient->listCalculationGrids(payload);

rejectCalculationGridItem

Deny a Calculation Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	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	pricefx:DenyCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DenyCalculationGridItemResponse|error

Sample code:

pricefx:DenyCalculationGridItemResponse result = check pricefxClient->rejectCalculationGridItem(id, payload);

updateCalculationGrid

Update a Calculation Grid

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateCalculationGridRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCalculationGridResponse|error

Sample code:

pricefx:UpdateCalculationGridResponse result = check pricefxClient->updateCalculationGrid(payload);

updateCalculationGridItem

Update a Calculation Grid Item

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Calculation Grid Item you want to update
payload	pricefx:UpdateCalculationGridItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateCalculationGridItemResponse|error

Sample code:

pricefx:UpdateCalculationGridItemResponse result = check pricefxClient->updateCalculationGridItem(id, payload);

Action Types

addActionType

Add an Action Type

Parameters:

Name	Type	Required	Description
payload	pricefx:AddActionTypeRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddActionTypeResponse|error

Sample code:

pricefx:AddActionTypeResponse result = check pricefxClient->addActionType(payload);

deleteActionItemType

Delete an Action Item Type

Parameters:

Name	Type	Required	Description
payload	record {record {string typedId;} data;}	Yes	The general delete request. Deletes the object specified by typedId in the request body
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteActionItemTypeResponse|error

Sample code:

pricefx:DeleteActionItemTypeResponse result = check pricefxClient->deleteActionItemType(payload);

listActionTypes

List Action Types

Parameters:

Name	Type	Required	Description
payload	record {int endRow?; record {}? oldValues?; string operationType?; int startRow?; string textMatchStyle?; record {string _constructor?; string operator?; record {string fieldName?; string operator?; string value?;}[] criteria?;} data?;}	Yes	A general fetch request. A filter can be applied
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListActionTypesResponse|error

Sample code:

pricefx:ListActionTypesResponse result = check pricefxClient->listActionTypes(payload);

updateActionType

Update an Action Type

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateAITBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateActionTypeResponse|error

Sample code:

pricefx:UpdateActionTypeResponse result = check pricefxClient->updateActionType(payload);

Actions

createActionItem

Create an Action Item + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:AddActionItemRequest	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddActionItemResponse|error

Sample code:

pricefx:AddActionItemResponse result = check pricefxClient->createActionItem(payload);

deleteActionItem

Delete an Action Item

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteActionItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteActionItemResponse|error

Sample code:

pricefx:DeleteActionItemResponse result = check pricefxClient->deleteActionItem(payload);

executeLogic

Execute a Logic

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The typeCode of the Action Item you want to execute the calculation for
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ExecuteActionItemLogicResponse|error

Sample code:

pricefx:ExecuteActionItemLogicResponse result = check pricefxClient->executeLogic(typeCode, payload);

listActionItems

List Action Items

Parameters:

Name	Type	Required	Description
payload	pricefx:FetchAIBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListActionItemsResponse|error

Sample code:

pricefx:ListActionItemsResponse result = check pricefxClient->listActionItems(payload);

updateActionItem

Update an Action Item

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateActionItemRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateActionItemResponse|error

Sample code:

pricefx:UpdateActionItemResponse result = check pricefxClient->updateActionItem(payload);

Jobs & Tasks

cancelJob

Cancel a Job

Parameters:

Name	Type	Required	Description
id	string	Yes	id if the job you want to cancel
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->cancelJob(id, payload);

listJobs

List Jobs

Parameters:

Name	Type	Required	Description
payload	record {int endRow?; record {}? oldValues?; string operationType?; int startRow?; string textMatchStyle?; record {string _constructor?; string operator?; record {string fieldName?; string operator?; string value?;}[] criteria?;} data?;}	Yes	A general fetch request. A filter can be applied
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListJSTResponse|error

Sample code:

pricefx:ListJSTResponse result = check pricefxClient->listJobs(payload);

Workflow

addApproverStep

Add an Approver Step

Parameters:

Name	Type	Required	Description
currentStepId	string	Yes	The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint
payload	pricefx:AddApproverStepRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddApproverStepResponse|error

Sample code:

pricefx:AddApproverStepResponse result = check pricefxClient->addApproverStep(currentStepId, payload);

addWatcherStep

Add a Watcher Step

Parameters:

Name	Type	Required	Description
currentStepId	string	Yes	The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint
payload	pricefx:AddWatcherStepRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddWatcherStepResponse|error

Sample code:

pricefx:AddWatcherStepResponse result = check pricefxClient->addWatcherStep(currentStepId, payload);

approveDocument

Approve a Document

Parameters:

Name	Type	Required	Description
currentStepId	string	Yes	The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint
payload	pricefx:ApproveDocumentRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ApproveDocumentResponse|error

Sample code:

pricefx:ApproveDocumentResponse result = check pricefxClient->approveDocument(currentStepId, payload);

denyDocument

Deny a Document

Parameters:

Name	Type	Required	Description
currentStepId	string	Yes	The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint
payload	pricefx:DenyDocumentRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DenyDocumentResponse|error

Sample code:

pricefx:DenyDocumentResponse result = check pricefxClient->denyDocument(currentStepId, payload);

fetchPendingReviews

Fetch Pending Reviews

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:FetchPendingReviewsEnvelope|error

Sample code:

pricefx:FetchPendingReviewsEnvelope result = check pricefxClient->fetchPendingReviews();

getWorkflowDocument

Get a Workflow Document

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the approvable object you want to retrieve workflow details for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetWorkflowDocumentResponse|error

Sample code:

pricefx:GetWorkflowDocumentResponse result = check pricefxClient->getWorkflowDocument(typedId);

listPendingApprovals

List Pending Approvals

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListPendingApprovalsResponse|error

Sample code:

pricefx:ListPendingApprovalsResponse result = check pricefxClient->listPendingApprovals();

listUserSPendingApprovals

List User's Pending Approvals

Parameters:

Name	Type	Required	Description
loginName	string	Yes	The login name of the user you want to retrieve Pending Workflows for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListUserPendingApprovalsResponse|error

Sample code:

pricefx:ListUserPendingApprovalsResponse result = check pricefxClient->listUserSPendingApprovals(loginName);

listWorkflows

List Workflows

Parameters:

Name	Type	Required	Description
payload	pricefx:ListWorkflowsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListWorkflowsResponse|error

Sample code:

pricefx:ListWorkflowsResponse result = check pricefxClient->listWorkflows(payload);

setReviewAsDone

Set a Review as Done

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the object to mark as reviewed
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->setReviewAsDone(typedId, payload);

updateReviewStatus

Update a Review Status

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the object to update
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->updateReviewStatus(typedId, payload);

withdrawDocument

Withdraw a Document

Parameters:

Name	Type	Required	Description
currentStepId	string	Yes	The ID of the workflow step. It can be retrieved using the /workflowsmanager.fetch/active (List Pending Approvals) endpoint
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:WithdrawDocumentResponse|error

Sample code:

pricefx:WithdrawDocumentResponse result = check pricefxClient->withdrawDocument(currentStepId);

Workflow Delegation

createWorkflowDelegation

Create a Workflow Delegation

Parameters:

Name	Type	Required	Description
payload	pricefx:CreateWorkflowDelegationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:CreateWorkflowDelegationResponse|error

Sample code:

pricefx:CreateWorkflowDelegationResponse result = check pricefxClient->createWorkflowDelegation(payload);

deactivateWorkflowDelegation

Deactivate a Workflow Delegation

Parameters:

Name	Type	Required	Description
payload	pricefx:DeactivateWorkflowDelegationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeactivateWorkflowDelegationResponse|error

Sample code:

pricefx:DeactivateWorkflowDelegationResponse result = check pricefxClient->deactivateWorkflowDelegation(payload);

deleteWorkflowDelegation

Delete a Workflow Delegation

Parameters:

Name	Type	Required	Description
payload	pricefx:DeleteWorkflowDelegationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteWorkflowDelegationResponse|error

Sample code:

pricefx:DeleteWorkflowDelegationResponse result = check pricefxClient->deleteWorkflowDelegation(payload);

listDelegatedWorkflows

List Delegated Workflows

Parameters:

Name	Type	Required	Description
payload	pricefx:ListDelegatedWorkflowsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListDelegatedWorkflowsResponse|error

Sample code:

pricefx:ListDelegatedWorkflowsResponse result = check pricefxClient->listDelegatedWorkflows(payload);

updateWorkflowDelegation

Update a Workflow Delegation

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateWorkflowDelegationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateWorkflowDelegationResponse|error

Sample code:

pricefx:UpdateWorkflowDelegationResponse result = check pricefxClient->updateWorkflowDelegation(payload);

validateWorkflowDelegation

Validate a Workflow Delegation

Parameters:

Name	Type	Required	Description
payload	pricefx:ValidateWorkflowDelegationRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ValidateWorkflowDelegationResponse|error

Sample code:

pricefx:ValidateWorkflowDelegationResponse result = check pricefxClient->validateWorkflowDelegation(payload);

Notifications

deleteNotification

Delete a Notification

Parameters:

Name	Type	Required	Description
payload	pricefx:NotificationSetreadBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteNotificationEnvelope|error

Sample code:

pricefx:DeleteNotificationEnvelope result = check pricefxClient->deleteNotification(payload);

listNotifications

List Notifications

Parameters:

Name	Type	Required	Description
payload	pricefx:NotificationListBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListNotificationsEnvelope|error

Sample code:

pricefx:ListNotificationsEnvelope result = check pricefxClient->listNotifications(payload);

markAsRead

Mark as Read

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->markAsRead(payload);

sendValidationMessage

Send a Validation Message

Parameters:

Name	Type	Required	Description
payload	pricefx:NotificationSendBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->sendValidationMessage(payload);

Internationalization

addNewInternationalizationMessage

Add a New Internationalization Message + payload -

Parameters:

Name	Type	Required	Description
payload	pricefx:I18nmanagerPutBody	Yes
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AddInternationalizationMessageEnvelope|error

Sample code:

pricefx:AddInternationalizationMessageEnvelope result = check pricefxClient->addNewInternationalizationMessage(payload);

deleteInternationalizationMessages

Delete Internationalization Messages

Parameters:

Name	Type	Required	Description
payload	pricefx:I18nmanagerDeleteKeysBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->deleteInternationalizationMessages(payload);

listInternationalizationMessages

List Internationalization Messages

Parameters:

Name	Type	Required	Description
payload	pricefx:I18nmanagerFetchWithExtraDataBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListInternationalizationMessagesEnvelope|error

Sample code:

pricefx:ListInternationalizationMessagesEnvelope result = check pricefxClient->listInternationalizationMessages(payload);

Clicmanager

addLineItems

Add Line Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typed ID of the target CLIC document
payload	pricefx:ClicmanagerAdditemstypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: record

Sample code:

record result = check pricefxClient->addLineItems(typedId, payload);

fetchActivities

Fetch Activities

Parameters:

Name	Type	Required	Description
payload	pricefx:ActivitylogFetchBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: record

Sample code:

record result = check pricefxClient->fetchActivities(payload);

getClicHeader

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

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Contract, Quote, or Rebate Agreement you want to return details for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetQuoteContractRebateAgreementResponse|error

Sample code:

pricefx:GetQuoteContractRebateAgreementResponse result = check pricefxClient->getClicHeader(typedId);

importClicLineItems

Import Line Items (w/o Input Types)

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	pricefx:ClicmanagerImportlineitemstypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ClicOperationEnvelope|error

Sample code:

pricefx:ClicOperationEnvelope result = check pricefxClient->importClicLineItems(typedId, payload);

listClicObjects

List CLIC Objects

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Quote/Contract/Rebate Agreement/Compensation Plan you want to retrieve line items for
payload	pricefx:GetCLICrequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:ListClicObjectsQueries	Yes	Queries to be sent with the request

Returns: pricefx:GetCLICresponse|error

Sample code:

pricefx:GetCLICresponse result = check pricefxClient->listClicObjects(typedId, payload, queries);

listUniqueClicItems

List Unique CLIC Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListUniqueCLICItemsResponse|error

Sample code:

pricefx:ListUniqueCLICItemsResponse result = check pricefxClient->listUniqueClicItems(typedId, payload);

removeAllClicLineItems

Delete All Line Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the object you want to remove all line items from
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ClicOperationEnvelope|error

Sample code:

pricefx:ClicOperationEnvelope result = check pricefxClient->removeAllClicLineItems(typedId, payload);

sendEmail

Send an Email

Parameters:

Name	Type	Required	Description
payload	pricefx:SendEmailRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->sendEmail(payload);

setClicLostReason

Mark an Offer as Lost (with reason)

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the Quote you want set as lost
payload	pricefx:MarkOfferLostWithReasonRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SetClicLostReasonEnvelope|error

Sample code:

pricefx:SetClicLostReasonEnvelope result = check pricefxClient->setClicLostReason(typedId, payload);

submitClic

Submit a Quote/Contract/Rebate Agreement

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Contract, Quote, or Rebate Agreement you want to submit
payload	pricefx:SubmitQuoteContractRebateAgreementRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SubmitQuoteContractRebateAgreementResponse|error

Sample code:

pricefx:SubmitQuoteContractRebateAgreementResponse result = check pricefxClient->submitClic(typedId, payload);

updateClicLineItems

Update CLIC Line Items

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the CLIC object (e.g., a Quote) you want to update line items for
payload	pricefx:UpdateCLICLineItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpdateClicLineItemsEnvelope|error

Sample code:

pricefx:UpdateClicLineItemsEnvelope result = check pricefxClient->updateClicLineItems(typedId, payload);

Advanced Configuration Options

getAdvancedConfigurationProperty

Get Advanced Configuration Property

Parameters:

Name	Type	Required	Description
propertyname	string	Yes	Name of the configuration property to retrieve
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:AdvancedConfigPropertyEnvelope|error

Sample code:

pricefx:AdvancedConfigPropertyEnvelope result = check pricefxClient->getAdvancedConfigurationProperty(propertyname);

Admin Tools

changeTermsOfUse

changeTermsOfUse

Parameters:

Name	Type	Required	Description
payload	pricefx:AccountmanagerChangetermsofuseBody	Yes
headers	map<string|string[]>	No

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->changeTermsOfUse(payload);

pingWithout

Ping (without authentication)

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->pingWithout();

Configuration

getExternalApplicationProperties

Get External Application Properties

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetexternalapppropertiesResponse|error

Sample code:

pricefx:GetexternalapppropertiesResponse result = check pricefxClient->getExternalApplicationProperties();

Visual Configuration

addConfigurationStorage

Add a Configuration Storage

Parameters:

Name	Type	Required	Description
payload	pricefx:AddJCSBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConfigurationStorageOperationEnvelope|error

Sample code:

pricefx:ConfigurationStorageOperationEnvelope result = check pricefxClient->addConfigurationStorage(payload);

deleteConfigurationStorage

Delete a Configuration Storage

Parameters:

Name	Type	Required	Description
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConfigurationStorageOperationEnvelope|error

Sample code:

pricefx:ConfigurationStorageOperationEnvelope result = check pricefxClient->deleteConfigurationStorage(payload);

deployConfigurationStorage

Deploy a Configuration Storage

Parameters:

Name	Type	Required	Description
payload	pricefx:JcsmanagerDeployBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConfigurationStorageOperationEnvelope|error

Sample code:

pricefx:ConfigurationStorageOperationEnvelope result = check pricefxClient->deployConfigurationStorage(payload);

getConfigurationStorage

Get a Configuration Storage

Parameters:

Name	Type	Required	Description
payload	pricefx:FetchJCSBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetConfigurationStorageEnvelope|error

Sample code:

pricefx:GetConfigurationStorageEnvelope result = check pricefxClient->getConfigurationStorage(payload);

updateConfigurationStorage

Update a Configuration Storage

Parameters:

Name	Type	Required	Description
payload	pricefx:UpdateJCSBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ConfigurationStorageOperationEnvelope|error

Sample code:

pricefx:ConfigurationStorageOperationEnvelope result = check pricefxClient->updateConfigurationStorage(payload);

Metadata

listAttributeFieldsMetadata

List Attribute Fields' Metadata

Parameters:

Name	Type	Required	Description
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"	Yes	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[]>	No	Headers to be sent with the request
queries	*pricefx:ListAttributeFieldsMetadataQueries	Yes	Queries to be sent with the request

Returns: pricefx:ListAttributeFieldsMetadata|error

Sample code:

pricefx:ListAttributeFieldsMetadata result = check pricefxClient->listAttributeFieldsMetadata(typeCode, queries);

listEntityFields

List Entity Fields

Parameters:

Name	Type	Required	Description
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"	Yes	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[]>	No	Headers to be sent with the request
queries	*pricefx:ListEntityFieldsQueries	Yes	Queries to be sent with the request

Returns: pricefx:ListEntityFieldsResponse|error

Sample code:

pricefx:ListEntityFieldsResponse result = check pricefxClient->listEntityFields(typeCode, queries);

General

createObject

Create an Object

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
payload	pricefx:CreateObjectRequest_1	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->createObject(typeCode, payload);

deleteColumnValues

Delete Column Values

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
columnName	string	Yes	The name of the column/attribute you want to remove values from
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteColumnValuesResponse|error

Sample code:

pricefx:DeleteColumnValuesResponse result = check pricefxClient->deleteColumnValues(typeCode, columnName);

deleteObject

Delete an Object

Parameters:

Name	Type	Required	Description
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"	Yes	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	pricefx:DeleteObjectRequest_1	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteObjectResponse_1|error

Sample code:

pricefx:DeleteObjectResponse_1 result = check pricefxClient->deleteObject(typeCode, payload);

deleteObjects

Delete Objects

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
payload	pricefx:DeleteObjectsForceFilterRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:DeleteObjectsResponse|error

Sample code:

pricefx:DeleteObjectsResponse result = check pricefxClient->deleteObjects(typeCode, payload);

getObject

Get an Object

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
id	string	Yes	The ID of the object you want to retrieve details for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetObjectResponse_1|error

Sample code:

pricefx:GetObjectResponse_1 result = check pricefxClient->getObject(typeCode, id);

getQueryApiMetadata

Get Query API Metadata

Parameters:

Name	Type	Required	Description
payload	pricefx:QueryapiExecuteBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:QueryApiMetadataEnvelope|error

Sample code:

pricefx:QueryApiMetadataEnvelope result = check pricefxClient->getQueryApiMetadata(payload);

insertBulkData

Insert Bulk Data

Parameters:

Name	Type	Required	Description
typeCode	pricefx:TypeCodeEnum	Yes	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	pricefx:InsertBulkDataRequest	Yes	The /loaddata/P endpoint (Insert Bulk Products) is used in our example.<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:LoadDataResponse|error

Sample code:

pricefx:LoadDataResponse result = check pricefxClient->insertBulkData(typeCode, payload);

insertBulkDataFromFile

Insert Bulk Data From a File

Parameters:

Name	Type	Required	Description
typeCode	"C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG"	Yes	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	pricefx:InsertBulkDataFromFileRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:InsertBulkDataFromFileQueries	Yes	Queries to be sent with the request

Returns: pricefx:InsertBulkDataFromFileResponse|error

Sample code:

pricefx:InsertBulkDataFromFileResponse result = check pricefxClient->insertBulkDataFromFile(typeCode, payload, queries);

insertBulkDataFromFileAsync

Insert Bulk Data From a File (async)

Parameters:

Name	Type	Required	Description
typeCode	"C"|"CDESC"|"CX"|"JLTV"|"LTV"|"MLTV"|"P"|"PBOME"|"PCOMP"|"PDESC"|"PR"|"PX"|"PXREF"|"SL"|"SX"|"TODO"|"UG"	Yes	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	pricefx:InsertBulkDataFromFileAsyncRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:InsertBulkDataFromFileAsyncQueries	Yes	Queries to be sent with the request

Returns: pricefx:InsertBulkDataFromFileAsyncResponse|error

Sample code:

pricefx:InsertBulkDataFromFileAsyncResponse result = check pricefxClient->insertBulkDataFromFileAsync(typeCode, payload, queries);

listObjects

List Objects

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
payload	pricefx:ListObjectsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->listObjects(typeCode, payload);

listTypeCodes

List Type Codes

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:TypeCodesResponse|error?

Sample code:

pricefx:TypeCodesResponse|error? result = check pricefxClient->listTypeCodes();

massUpdate

Mass Update

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
payload	pricefx:MassUpdateRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:MassUpdateResponse|error

Sample code:

pricefx:MassUpdateResponse result = check pricefxClient->massUpdate(typeCode, payload);

queryApiExecute

Query API Execute

Parameters:

Name	Type	Required	Description
payload	pricefx:QueryapiExecuteBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:QueryApiExecuteQueries	Yes	Queries to be sent with the request

Returns: pricefx:QueryApiExecuteEnvelope|error

Sample code:

pricefx:QueryApiExecuteEnvelope result = check pricefxClient->queryApiExecute(payload, queries);

updateObject

Update an Object

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
payload	pricefx:UpdateObjectRequest	Yes	<!-- theme: warning -->
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->updateObject(typeCode, payload);

updateObjectReturningOldData

Update an Object (and return old data)

Parameters:

Name	Type	Required	Description
typeCode	string	Yes	The object's type code. See the list of Type Codes
payload	pricefx:UpdateObjectReturnOldDataRequest	Yes	<!-- theme: warning -->
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

error? result = check pricefxClient->updateObjectReturningOldData(typeCode, payload);

upsertObject

Upsert an Object

Parameters:

Name	Type	Required	Description
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"	Yes	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	pricefx:UpsertObjectRequest	Yes	The /integrate/P endpoint (Upsert a Product) is used in our example.<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ProductResponse|error

Sample code:

pricefx:ProductResponse result = check pricefxClient->upsertObject(typeCode, payload);

upsertObjectReturningOldData

Upsert an Object (and return old data)

Parameters:

Name	Type	Required	Description
typeCode	pricefx:TypeCodeEnum	Yes	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	pricefx:UpsertObjectReturnOldDataRequest	Yes	The /integrate/P/returnolddata endpoint (upserts a product) is used in our example.<p>
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:UpsertObjectReturnOldDataResponse|error

Sample code:

pricefx:UpsertObjectReturnOldDataResponse result = check pricefxClient->upsertObjectReturningOldData(typeCode, payload);

Optimization

calculateModelObjectStep

Calculate a Model Object Step

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to recalculate the step for
stepName	"definition"|"configuration"|"results"|"projections"|"parallel"	Yes	Enter the name of the step you want to calculate
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:CalculateModelObjectStepQueries	Yes	Queries to be sent with the request

Returns: pricefx:ModelCalculationStepEnvelope|error

Sample code:

pricefx:ModelCalculationStepEnvelope result = check pricefxClient->calculateModelObjectStep(typedId, stepName, queries);

cancelCalculationStep

Cancel a Calculation Step

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to cancel the calculation step for
stepName	string	Yes	The name of the step you want to cancel
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:JobStatusTrackerResponse|error

Sample code:

pricefx:JobStatusTrackerResponse result = check pricefxClient->cancelCalculationStep(typedId, stepName);

duplicateModel

Duplicate a Model

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId to be sent with the request
payload	pricefx:OptimizationModelduplicatetypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ModelDuplicationEnvelope|error

Sample code:

pricefx:ModelDuplicationEnvelope result = check pricefxClient->duplicateModel(typedId, payload);

executeModelLogic

Execute a Model Logic

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to execute the logic for
stepName	string	Yes	The name of the step you want to execute the logic for
formulaName	string	Yes	The name of the logic you want to execute
payload	pricefx:ExecuteModelLogicRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ExecuteModelLogicResponse|error

Sample code:

pricefx:ExecuteModelLogicResponse result = check pricefxClient->executeModelLogic(typedId, stepName, formulaName, payload);

exportModels

Export Models

Parameters:

Name	Type	Required	Description
payload	pricefx:OptimizationModelexportBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->exportModels(payload);

getCalculationStatus

Get a Calculation Status

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to retrieve the calculation status for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:JobStatusTrackerResponse|error

Sample code:

pricefx:JobStatusTrackerResponse result = check pricefxClient->getCalculationStatus(typedId);

getParallelCalculationItem

Get a Parallel Calculation Item

Parameters:

Name	Type	Required	Description
id	string	Yes	id of the Parallel Calculation Item (PCI) you want to retrieve
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GetParallelCalculationItemResponse|error

Sample code:

pricefx:GetParallelCalculationItemResponse result = check pricefxClient->getParallelCalculationItem(id, payload);

getStepCalculationStatus

Get a Step Calculation Status

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to retrieve the calculation status for
stepName	string	Yes	The name of the step you want to calculate
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:JobStatusTrackerResponse|error

Sample code:

pricefx:JobStatusTrackerResponse result = check pricefxClient->getStepCalculationStatus(typedId, stepName);

importModels

Import Models

Parameters:

Name	Type	Required	Description
payload	pricefx:OptimizationModelimportBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ModelDuplicationEnvelope|error

Sample code:

pricefx:ModelDuplicationEnvelope result = check pricefxClient->importModels(payload);

listModelLogicParameters

List Model Logic Parameters

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to retrieve logic parameters for
stepName	string	Yes	The name of the step you want to list logic parameters for
formulaName	string	Yes	The name of the logic you want to get parameters for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListModelLogicParametersResponse|error

Sample code:

pricefx:ListModelLogicParametersResponse result = check pricefxClient->listModelLogicParameters(typedId, stepName, formulaName);

listParallelCalculationItems

List Parallel Calculation Items

Parameters:

Name	Type	Required	Description
payload	pricefx:ListParallelCalculationItemsRequest	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListParallelCalculationItemsResponse|error

Sample code:

pricefx:ListParallelCalculationItemsResponse result = check pricefxClient->listParallelCalculationItems(payload);

loadDataIntoFieldCollection

Load Data Into FieldCollection

Parameters:

Name	Type	Required	Description
typedId	string	Yes	Specifies the typedId (format: {id}.{type}) of the FieldCollection to load data into. Type must be either DMDS or DMT
payload	pricefx:DatamartLoadfctypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: http:Response|error

Sample code:

http:Response result = check pricefxClient->loadDataIntoFieldCollection(typedId, payload);

recalculateCalculationOfStep

Recalculate a Calculation of a Step

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to recalculate the step for
stepName	"definition"|"configuration"|"results"|"projections"|"parallel"	Yes	Enter the name of the step you want to calculate
calcName	string	Yes	The name of the calculation you want to recalculate
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RecalculateCalculationOfStepResponse|error

Sample code:

pricefx:RecalculateCalculationOfStepResponse result = check pricefxClient->recalculateCalculationOfStep(typedId, stepName, calcName, payload);

recalculateItemsOfParallelCalculation

Recalculate Items of a Parallel Calculation

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to recalculate the step for
stepName	"definition"|"configuration"|"results"|"projections"|"parallel"	Yes	Enter the name of the step you want to calculate
calcName	string	Yes	The name of the calculation you want to recalculate
payload	pricefx:CalcNameItemBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ParallelCalculationEnvelope|error

Sample code:

pricefx:ParallelCalculationEnvelope result = check pricefxClient->recalculateItemsOfParallelCalculation(typedId, stepName, calcName, payload);

revokeModel

Revoke a Model

Parameters:

Name	Type	Required	Description
typedId	string	Yes	typedId of the model you want to revoke
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:RevokeModelResponse|error

Sample code:

pricefx:RevokeModelResponse result = check pricefxClient->revokeModel(typedId, payload);

saveModel

Save a Model

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to save
stepName	"definition"|"configuration"|"results"|"projections"	Yes	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	pricefx:SaveModelRequest	Yes	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[]>	No	Headers to be sent with the request

Returns: pricefx:SaveModelResponse|error

Sample code:

pricefx:SaveModelResponse result = check pricefxClient->saveModel(typedId, stepName, payload);

submitModel

Submit a Model

Parameters:

Name	Type	Required	Description
typedId	string	Yes	The typedId of the Model Object you want to submit
payload	record {}	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:SaveModelResponse|error

Sample code:

pricefx:SaveModelResponse result = check pricefxClient->submitModel(typedId, payload);

updateJobStatusTrackerEntry

Update Job Status Tracker Entry

Parameters:

Name	Type	Required	Description
payload	pricefx:OptimizationUpdatejstBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:JobStatusTrackerUpdateEnvelope|error

Sample code:

pricefx:JobStatusTrackerUpdateEnvelope result = check pricefxClient->updateJobStatusTrackerEntry(payload);

Logs

getLokiLog

Get a Loki Log

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request
queries	*pricefx:GetLokiLogQueries	Yes	Queries to be sent with the request

Returns: pricefx:LokiLogEnvelope|error

Sample code:

pricefx:LokiLogEnvelope result = check pricefxClient->getLokiLog(queries);

listEmailTasks

List Email Tasks

Parameters:

Name	Type	Required	Description
payload	pricefx:NotificationListBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListEmailTasksEnvelope|error

Sample code:

pricefx:ListEmailTasksEnvelope result = check pricefxClient->listEmailTasks(payload);

listEventTasks

List Event Tasks

Parameters:

Name	Type	Required	Description
payload	pricefx:NotificationListBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListEventTasksEnvelope|error

Sample code:

pricefx:ListEventTasksEnvelope result = check pricefxClient->listEventTasks(payload);

listLogins

List Logins

Parameters:

Name	Type	Required	Description
payload	pricefx:BdmanagerListtypedIdBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListLoginsEnvelope|error

Sample code:

pricefx:ListLoginsEnvelope result = check pricefxClient->listLogins(payload);

listSecurityConfigurationEvents

List Security & Configuration Events

Parameters:

Name	Type	Required	Description
payload	pricefx:NotificationListBody	Yes	Request payload
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:ListSecurityConfigEventsEnvelope|error

Sample code:

pricefx:ListSecurityConfigEventsEnvelope result = check pricefxClient->listSecurityConfigurationEvents(payload);

Heartbeat

listTasks

List Tasks

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:GenericDataResponse|error

Sample code:

pricefx:GenericDataResponse result = check pricefxClient->listTasks();

MCP

getMcpRoles

Get MCP Roles

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:McpRolesEnvelope|error

Sample code:

pricefx:McpRolesEnvelope result = check pricefxClient->getMcpRoles();

getMcpTools

Get MCP Tools

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: pricefx:McpToolsEnvelope|error

Sample code:

pricefx:McpToolsEnvelope result = check pricefxClient->getMcpTools();