# Sales Compensations

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

 - [POST /clicmanager.fetchheader/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/quotes/post-clicmanager.fetchheader-typedid.md): Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.



>Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.

## List CLIC Objects

 - [POST /clicmanager.fetch/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/quotes/post-clicmanager.fetch.md): Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Update CLIC Line Items

 - [POST /clicmanager.updatelineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/quotes/post-clicmanager.updatelineitems-typedid.md): Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).

## Delete All Line Items

 - [POST /clicmanager.removeallitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/quotes/post-clicmanager.removeallitems-typedid.md): Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.
This action can be performed only on doucments in the DRAFT status.
>If 'Recalculate after line item modification' option is set then the document is recalculated.

## Import Line Items (w/o Input Types)

 - [POST /clicmanager.importlineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/quotes/post-clicmanager.importlineitems-typedid.md): Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.
The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.

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

 - [POST /clicmanager.fetchheader/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/contracts-(agreements-and-promotions)/post-clicmanager.fetchheader-typedid.md): Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.



>Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.

## List CLIC Objects

 - [POST /clicmanager.fetch/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/contracts-(agreements-and-promotions)/post-clicmanager.fetch.md): Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Update CLIC Line Items

 - [POST /clicmanager.updatelineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/contracts-(agreements-and-promotions)/post-clicmanager.updatelineitems-typedid.md): Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).

## Delete All Line Items

 - [POST /clicmanager.removeallitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/contracts-(agreements-and-promotions)/post-clicmanager.removeallitems-typedid.md): Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.
This action can be performed only on doucments in the DRAFT status.
>If 'Recalculate after line item modification' option is set then the document is recalculated.

## Import Line Items (w/o Input Types)

 - [POST /clicmanager.importlineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/contracts-(agreements-and-promotions)/post-clicmanager.importlineitems-typedid.md): Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.
The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.

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

 - [POST /clicmanager.fetchheader/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/rebate-agreements/post-clicmanager.fetchheader-typedid.md): Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.



>Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.

## List CLIC Objects

 - [POST /clicmanager.fetch/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/rebate-agreements/post-clicmanager.fetch.md): Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Update CLIC Line Items

 - [POST /clicmanager.updatelineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/rebate-agreements/post-clicmanager.updatelineitems-typedid.md): Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).

## Delete All Line Items

 - [POST /clicmanager.removeallitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/rebate-agreements/post-clicmanager.removeallitems-typedid.md): Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.
This action can be performed only on doucments in the DRAFT status.
>If 'Recalculate after line item modification' option is set then the document is recalculated.

## Import Line Items (w/o Input Types)

 - [POST /clicmanager.importlineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/rebate-agreements/post-clicmanager.importlineitems-typedid.md): Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.
The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.

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

 - [POST /clicmanager.fetchheader/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-clicmanager.fetchheader-typedid.md): Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.



>Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.

## Add a Compensation Type

 - [POST /add/COHT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-add-coht.md): Creates a Compensation Type record in the Compensation Header Types table.

## List Compensation Types

 - [POST /fetch/COHT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-fetch-coht.md): Retrieves Compensation Types from the Compensation Header Types table. A filter can be applied.

## Update a Compensation Type

 - [POST /update/COHT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-update-coht.md): Updates a Compensation Type in the Compensation Header Types table. The version property must be provided within the oldValues.

## Delete a Compensation Type

 - [POST /delete/COHT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-delete-coht.md): Deletes a Compensation Type from the Compensation Header Types table.

## Add a Condition Type

 - [POST /add/COCT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-add-coct.md): Creates a Condition Type record in the Compensation Condition Types table.

## List Condition Types

 - [POST /fetch/COCT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-fetch-coct.md): Retrieves one or more (based on filter settings) Condition Types from the Compensation Condition Types table.

## Update a Condition Type

 - [POST /update/COCT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-update-coct.md): Updates a Condition Type in the Compensation Condition Types table. The version property must be provided within the oldValues.

## Delete a Condition Type

 - [POST /delete/COCT](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-delete-coct.md): Deletes a Condition Type from the Compensation Condition Types table.

## Upsert a Compensation Plan

 - [POST /compensation.save](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensation.save.md): Creates or updates a Compensation Plan. Assigns new uniqueName when a new Compensation Plan is created. To update a Compensation Plan, specify the existing uniqueName.

## List Compensation Plans

 - [POST /fetch/CO](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-fetch-co.md): Retrieves Compensation Plans. A filter can be applied.

## List CLIC Objects

 - [POST /clicmanager.fetch/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-clicmanager.fetch.md): Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Update a Quote/Contract/Rebate Agreement/Compensation Plan

 - [POST /clicmanager.update/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-clicmanager.update-typedid.md): Updates a Quote, Contract, Rebate Agreement, or Compensation Plan.
attributeExtension can be updated as follows:
json
{
                "data": {
                    "typedId": "{typedId}",
                    "version": {version},
                    "attributeExtension___AttributeExtensionColumn2": "testValue"
                }
            }



>This endpoint is not allowed to modify the document status and workflow status.
>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Delete a Compensation Plan

 - [POST /delete/CO](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-delete-co.md): Deletes a Compensation Plan.

## Duplicate a Compensation Plan

 - [POST /compensation.copy/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensation.copy.md): Creates a copy of the specified Compensation Plan.

## Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan

 - [POST /clicmanager.calculate/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-clicmanager.calculate-typedid.md): Calculates a Quote, Contract, Rebate Agreement, or Compensation Plan.
>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Add a Calculation

 - [POST /add/CORSC](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-add-corsc.md): Adds a Calculation (CompensationRecordSetCalculation) for the specified Compensation Record Set.

## List Calculations

 - [POST /fetch/CORSC](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-fetch-corsc.md): Retrieves Calculation (CompensationRecordSetCalculation) objects. A filter can be applied.

## Save Calculation

 - [POST /calculationrecord.savecalc](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-calculationrecord.savecalc.md): Updates Calculation details.

## Run a Calculation

 - [POST /calculationrecord.calculateset](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-calculationrecord.calculateset.md): Starts the calculation job (JST) of the calculation set. Returns the JobStatusTracker object.

## Delete a Calculation

 - [POST /clicmanager.deleteCompensationCalculation](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-delete-clicmanager.deletecompensationcalculation.md): Deletes the specified CompensationRecordSetCalculation object. Returns the deleted object in the response.

## Save a Compensation Record

 - [POST /compensationrecord.save](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensationrecord.save.md): Updates a Compensation Record.

## List Compensation Records

 - [POST /compensationrecord.fetch/{compensationRecordSetId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensationrecord.fetch.md): Retrieves all Compensation Records based on filter settings.

## Update a Compensation Record

 - [POST /compensationrecord.update](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensationrecord.update.md): Updates a CompensationRecord object.

## Revoke a Compensation Record

 - [POST /compensationrecord.revoke/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensationrecord.revoke.md): The Revoke action is available only for approved records. This action is useful when the Compensation Record was approved in Pricefx, integration did not happen yet and there is nothing to reverse in ERP. When this action is used, the record changes its status to Revoked.
The Administer Compensation Records user role is needed to perform the Revoke action.

## List Accrual Records

 - [POST /fetch/COAR](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-fetch-coar.md): Retrieves Accrual Records. A filter can be applied.

## Send a Document to Sign

 - [POST /compensation.createsignature/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensation.createsignature-typedid.md): Sends the template with the specified Compensation document data via the e-signature system (DocuSign) and returns the Compensation object.

## Get a Signed Document

 - [POST /compensation.fetchsignature/{uniqueName}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensation.fetchsignature.md): Downloads a signed document.

## Get a Signature Status

 - [POST /compensation.signaturestatus/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensation.signaturestatus-typedid.md): Returns the Compensation object (CO) with the updated signature status (possible values: sent, delivered, signed, completed, declined, voided, processing, error, cancelling).

## Update CLIC Line Items

 - [POST /clicmanager.updatelineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-clicmanager.updatelineitems-typedid.md): Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).

## Delete All Line Items

 - [POST /clicmanager.removeallitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-clicmanager.removeallitems-typedid.md): Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.
This action can be performed only on doucments in the DRAFT status.
>If 'Recalculate after line item modification' option is set then the document is recalculated.

## Import Line Items (w/o Input Types)

 - [POST /clicmanager.importlineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-clicmanager.importlineitems-typedid.md): Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.
The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.

## Undo Compensation Plan Revocation

 - [POST /compensation.undorevoke/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensation.undorevoke-typedid.md): Reverts the action 'Revoke Compensation Plan' and returns the Compensation Plan back to the Approved status. It is useful if the user revokes a Compensation Plan by mistake. There is no button for this action available in the UI.

## Undo Compensation Record Revocation

 - [POST /compensationrecord.undorevoke/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/sales-compensations/post-compensationrecord.undorevoke-typedid.md): Reverts the action 'Revoke' and returns the Compensation Record back to the Approved status. It is useful if the user revokes a Compensation Record by mistake. There is no button for this action available in the UI.

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

 - [POST /clicmanager.fetchheader/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/clicmanager/post-clicmanager.fetchheader-typedid.md): Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.



>Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.

## List CLIC Objects

 - [POST /clicmanager.fetch/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/clicmanager/post-clicmanager.fetch.md): Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).


>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Update a Quote/Contract/Rebate Agreement/Compensation Plan

 - [POST /clicmanager.update/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/clicmanager/post-clicmanager.update-typedid.md): Updates a Quote, Contract, Rebate Agreement, or Compensation Plan.
attributeExtension can be updated as follows:
json
{
                "data": {
                    "typedId": "{typedId}",
                    "version": {version},
                    "attributeExtension___AttributeExtensionColumn2": "testValue"
                }
            }



>This endpoint is not allowed to modify the document status and workflow status.
>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan

 - [POST /clicmanager.calculate/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/clicmanager/post-clicmanager.calculate-typedid.md): Calculates a Quote, Contract, Rebate Agreement, or Compensation Plan.
>This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.

## Update CLIC Line Items

 - [POST /clicmanager.updatelineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/clicmanager/post-clicmanager.updatelineitems-typedid.md): Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).

## Delete All Line Items

 - [POST /clicmanager.removeallitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/clicmanager/post-clicmanager.removeallitems-typedid.md): Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.
This action can be performed only on doucments in the DRAFT status.
>If 'Recalculate after line item modification' option is set then the document is recalculated.

## Import Line Items (w/o Input Types)

 - [POST /clicmanager.importlineitems/{typedId}](https://api.pricefx.com/openapi/reference/pricefx-server_openapi/clicmanager/post-clicmanager.importlineitems-typedid.md): Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.
The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.