Version 1.0
Connector Overview: This page documents all 407 actions for the Rightslineconnector v1.0.
Allocation
GET /v4/allocation-model-list
/v4/allocation-model-list
Retrieve a list of allocation models available in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Amount (29)
POST /v4/amount
/v4/amount
Create a new amount record with the specified properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/amount-processes
/v4/amount-processes
Retrieve a list of amount processes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount-statuses/{templateId}
/v4/amount-statuses/{templateId}
Retrieve the statuses associated with a specific amount template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount-templates
/v4/amount-templates
Retrieve a list of all amount templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount-templates/{id}
/v4/amount-templates/{id}
Retrieve details for a specific amount template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount-templates/{id}/{tagLabel}
/v4/amount-templates/{id}/{tagLabel}
Retrieve an amount template filtered by a specific tag label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/amount/data-default
/v4/amount/data-default
Create default data for an amount record with the specified characteristics.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
DELETE /v4/amount/data-default/{setGuid}
/v4/amount/data-default/{setGuid}
Delete the default data set identified by the specified GUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The GUID of the default data set to delete. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/amount/search
/v4/amount/search
Search for amount records based on specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/amount/search-count
/v4/amount/search-count
Get the count of amount records matching the search criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/amount/search-deleted
/v4/amount/search-deleted
Search for deleted amounts based on various filter criteria such as character type, date ranges, and user IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/amount/{id}
/v4/amount/{id}
Permanently delete a specific amount record by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to delete a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount/{id}
/v4/amount/{id}
Retrieve the details of a specific amount record by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/amount/{id}
/v4/amount/{id}
Update an existing amount record identified by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/amount/{id}/audit-history
/v4/amount/{id}/audit-history
Retrieve the audit history for a specific amount record, optionally filtered by user, date range, or character types.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter audit records by the audit entry identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount/{id}/audit-history-detail
/v4/amount/{id}/audit-history-detail
Retrieve detailed audit history entries for a specific amount record, including field-level changes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount/{id}/copy-warnings
/v4/amount/{id}/copy-warnings
Retrieve any copy warnings associated with a specific amount record for a given template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount/{id}/data-default
/v4/amount/{id}/data-default
Retrieve the default data for a specific amount record identified by the path parameter id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/amount/{id}/data-default
/v4/amount/{id}/data-default
Create or update the default data for a specific amount record identified by the path parameter id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
GET /v4/amount/{id}/date-alerts
/v4/amount/{id}/date-alerts
Retrieve date alerts associated with a specific amount record identified by the path parameter id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount/{id}/date-math
/v4/amount/{id}/date-math
Retrieve date math calculations for a specific amount record identified by the path parameter id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount/{id}/draft-templates
/v4/amount/{id}/draft-templates
Retrieve draft templates related to a specific amount record identified by the path parameter id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/amount/{id}/execute-document-workflow-action/{actionID}
/v4/amount/{id}/execute-document-workflow-action/{actionID}
Execute a document workflow action on a specific amount record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the document workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/amount/{id}/execute-signature-workflow-action/{actionID}
/v4/amount/{id}/execute-signature-workflow-action/{actionID}
Execute a signature workflow action on a specific amount record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the signature workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/amount/{id}/execute-workflow-action/{actionID}
/v4/amount/{id}/execute-workflow-action/{actionID}
Execute a general workflow action on a specific amount record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/amount/{id}/get-lov-friendly-string/{tagLabel}
/v4/amount/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly string representation for a list of values tag associated with a specific amount record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/amount/{id}/switch-template
/v4/amount/{id}/switch-template
Switch the template used by a specific amount record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/amount/{id}/switch-template-check
/v4/amount/{id}/switch-template-check
Check whether a given amount can be switched to a different template and return the validation result.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/amount/{id}/validation-errors
/v4/amount/{id}/validation-errors
Retrieve all validation errors associated with a specific amount.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Auth
POST /v4/auth/temporary-credentials
/v4/auth/temporary-credentials
Obtain temporary authentication credentials for subsequent API calls.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The access key used to authenticate the request. |
|
|
The secret key used to authenticate the request. |
Avails (7)
GET /v4/avails/availability
/v4/avails/availability
Query availability for rights templates and deals based on dimensions, windows, exclusivity, and other filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (25)
|
Option Name |
Description |
|---|---|
|
|
One or more dimension IDs for the first dimension level to filter availability. |
|
|
One or more dimension IDs for the second dimension level to filter availability. |
|
|
One or more dimension IDs for the third dimension level to filter availability. |
|
|
One or more dimension IDs for the fourth dimension level to filter availability. |
|
|
The start date of the availability window to query. |
|
|
The end date of the availability window to query. |
|
|
When true, return only exclusive availability records. |
|
|
The type of match to apply when filtering availability (e.g., exact or partial). |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
When true, include user-friendly labels for dimension values in the response. |
|
|
When true, require an exact match on all specified dimensions. |
|
|
When true, enforce windowing rules when determining availability. |
|
|
When true, include records that are not available in the result. |
|
|
One or more template IDs to restrict the availability query to. |
|
|
One or more right template IDs to restrict the availability query to. |
|
|
One or more status IDs to filter availability by status. |
|
|
When true, include the deal IDs associated with each availability record. |
|
|
When true, truncate date ranges to the search window for more precise results. |
|
|
When true, include the recalculation status of each availability record. |
|
|
The minimum number of days an availability window must span to be included. |
|
|
The dimension ID used to roll up availability results. |
|
|
One or more dimension IDs that define the scope of the availability query. |
|
|
When true, scope the exclusivity filter to the specified dimensions. |
|
|
Filter results by the record identifier. |
POST /v4/avails/availability
/v4/avails/availability
Query availability of catalog items or rights based on criteria sent in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (25)
|
Option Name |
Description |
|---|---|
|
|
One or more dimension IDs for the first dimension level to filter availability. |
|
|
One or more dimension IDs for the second dimension level to filter availability. |
|
|
One or more dimension IDs for the third dimension level to filter availability. |
|
|
One or more dimension IDs for the fourth dimension level to filter availability. |
|
|
The start date of the availability window to query. |
|
|
The end date of the availability window to query. |
|
|
When true, return only exclusive availability records. |
|
|
The type of match to apply when filtering availability (e.g., exact or partial). |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
When true, include user-friendly labels for dimension values in the response. |
|
|
When true, require an exact match on all specified dimensions. |
|
|
When true, enforce windowing rules when determining availability. |
|
|
When true, include records that are not available in the result. |
|
|
One or more template IDs to restrict the availability query to. |
|
|
One or more right template IDs to restrict the availability query to. |
|
|
One or more status IDs to filter availability by status. |
|
|
When true, include the deal IDs associated with each availability record. |
|
|
When true, truncate date ranges to the search window for more precise results. |
|
|
When true, include the recalculation status of each availability record. |
|
|
The minimum number of days an availability window must span to be included. |
|
|
The dimension ID used to roll up availability results. |
|
|
One or more dimension IDs that define the scope of the availability query. |
|
|
When true, scope the exclusivity filter to the specified dimensions. |
|
|
Filter results by the record identifier. |
POST /v4/avails/available-catalog-items
/v4/avails/available-catalog-items
Retrieve a list of catalog items that are currently available based on the request criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (24)
|
Option Name |
Description |
|---|---|
|
|
One or more dimension IDs for the first dimension level to filter availability. |
|
|
One or more dimension IDs for the second dimension level to filter availability. |
|
|
One or more dimension IDs for the third dimension level to filter availability. |
|
|
One or more dimension IDs for the fourth dimension level to filter availability. |
|
|
The start date of the availability window to query. |
|
|
The end date of the availability window to query. |
|
|
When true, return only exclusive availability records. |
|
|
The type of match to apply when filtering availability (e.g., exact or partial). |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
When true, include user-friendly labels for dimension values in the response. |
|
|
When true, require an exact match on all specified dimensions. |
|
|
When true, enforce windowing rules when determining availability. |
|
|
When true, include records that are not available in the result. |
|
|
One or more template IDs to restrict the availability query to. |
|
|
One or more right template IDs to restrict the availability query to. |
|
|
One or more status IDs to filter availability by status. |
|
|
When true, include the deal IDs associated with each availability record. |
|
|
When true, truncate date ranges to the search window for more precise results. |
|
|
When true, include the recalculation status of each availability record. |
|
|
The minimum number of days an availability window must span to be included. |
|
|
The dimension ID used to roll up availability results. |
|
|
One or more dimension IDs that define the scope of the availability query. |
|
|
When true, scope the exclusivity filter to the specified dimensions. |
GET /v4/avails/dimension-data
/v4/avails/dimension-data
Retrieve dimension data used for structuring availability information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/avails/is-title-available
/v4/avails/is-title-available
Check if a title is available for licensing based on current rights and restrictions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (13)
|
Option Name |
Description |
|---|---|
|
|
One or more dimension IDs for the first dimension level to filter availability. |
|
|
One or more dimension IDs for the second dimension level to filter availability. |
|
|
One or more dimension IDs for the third dimension level to filter availability. |
|
|
One or more dimension IDs for the fourth dimension level to filter availability. |
|
|
The start date of the availability window to query. |
|
|
The end date of the availability window to query. |
|
|
When true, return only exclusive availability records. |
|
|
The type of match to apply when filtering availability (e.g., exact or partial). |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
When true, include user-friendly labels for dimension values in the response. |
|
|
Filter results by the record identifier. |
|
|
When true, include the recalculation status of each availability record. |
GET /v4/avails/reason-unavailable-list
/v4/avails/reason-unavailable-list
Retrieve a list of reasons why titles may be marked as unavailable.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/avails/recalc-status/{id}
/v4/avails/recalc-status/{id}
Get the current recalculation status for a specific avail record identified by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Batch (2)
POST /v4/batch
/v4/batch
Create a new batch job for processing rights data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify the batch processing method to use, such as "import" or "export". |
|
|
Provide the identifier of the amortization model to apply to the batch. |
GET /v4/batch/{batchId}
/v4/batch/{batchId}
Retrieve details of a specific batch job using its batch ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the batch job to retrieve. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Catalog-item (36)
POST /v4/catalog-item
/v4/catalog-item
Create a new catalog item record with the provided data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/catalog-item-processes
/v4/catalog-item-processes
List all available catalog item processes that can be applied.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item-statuses/{templateId}
/v4/catalog-item-statuses/{templateId}
Retrieve the list of statuses available for a specific catalog item template identified by its template ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item-templates
/v4/catalog-item-templates
List all catalog item templates defined in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item-templates/{id}
/v4/catalog-item-templates/{id}
Retrieve details of a specific catalog item template by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item-templates/{id}/{tagLabel}
/v4/catalog-item-templates/{id}/{tagLabel}
Retrieve a specific tag label within a catalog item template by template ID and tag label value.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/catalog-item/data-default
/v4/catalog-item/data-default
Set default data values for a new catalog item based on a template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
DELETE /v4/catalog-item/data-default/{setGuid}
/v4/catalog-item/data-default/{setGuid}
Delete a specific set of default data values identified by its GUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The GUID of the default data set to delete. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/catalog-item/search
/v4/catalog-item/search
Search for catalog items using a query body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/catalog-item/search-count
/v4/catalog-item/search-count
Get the count of catalog items matching a search query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/catalog-item/search-deleted
/v4/catalog-item/search-deleted
Search for deleted catalog items using a query body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/catalog-item/{id}
/v4/catalog-item/{id}
Permanently delete a catalog item by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}
/v4/catalog-item/{id}
Retrieve a single catalog item by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/catalog-item/{id}
/v4/catalog-item/{id}
Update an existing catalog item by its unique identifier with a request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/catalog-item/{id}/audit-history
/v4/catalog-item/{id}/audit-history
Retrieves the audit history for a specific catalog item. Use this to see a log of changes made to the item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/audit-history-detail
/v4/catalog-item/{id}/audit-history-detail
Retrieves detailed audit history entries for a specific catalog item. Use this to view the specific field-level changes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/copy-warnings
/v4/catalog-item/{id}/copy-warnings
Retrieves any warnings that would occur if the catalog item is copied. Use this to preview potential issues before performing a copy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/data-default
/v4/catalog-item/{id}/data-default
Retrieves the default data values for a specific catalog item. Use this to see the default configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/catalog-item/{id}/data-default
/v4/catalog-item/{id}/data-default
Creates or updates default data values for a specific catalog item. Use this to set default values for the item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
GET /v4/catalog-item/{id}/date-alerts
/v4/catalog-item/{id}/date-alerts
Retrieves date alerts associated with a specific catalog item. Use this to see upcoming deadlines or warnings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/date-math
/v4/catalog-item/{id}/date-math
Retrieves calculated date information for a specific catalog item. Use this to compute derived dates based on item data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/delete-check
/v4/catalog-item/{id}/delete-check
Checks whether a specific catalog item can be deleted. Use this to identify dependencies or restrictions before deleting.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specifies the number of records to skip for paginated results. Provide an integer value. |
|
|
Specifies the number of rows to return per page. Provide an integer value. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/draft-templates
/v4/catalog-item/{id}/draft-templates
Retrieves draft templates available for a specific catalog item. Use this to list templates that can be applied as drafts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/catalog-item/{id}/execute-document-workflow-action/{actionID}
/v4/catalog-item/{id}/execute-document-workflow-action/{actionID}
Executes a document workflow action on a specific catalog item. Use this to trigger a defined workflow action.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/catalog-item/{id}/execute-signature-workflow-action/{actionID}
/v4/catalog-item/{id}/execute-signature-workflow-action/{actionID}
Executes a signature workflow action on a specific catalog item. Use this to trigger a signature-related workflow step.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/catalog-item/{id}/execute-workflow-action/{actionID}
/v4/catalog-item/{id}/execute-workflow-action/{actionID}
Execute a specified workflow action on a catalog item, triggering the associated business logic.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/get-lov-friendly-string/{tagLabel}
/v4/catalog-item/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly display string for a list-of-values tag label associated with a catalog item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE /v4/catalog-item/{id}/keyart
/v4/catalog-item/{id}/keyart
Permanently delete the key art image associated with a catalog item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/catalog-item/{id}/keyart
/v4/catalog-item/{id}/keyart
Retrieve the key art image metadata or file for a catalog item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/catalog-item/{id}/keyart
/v4/catalog-item/{id}/keyart
Upload or update the key art image for a catalog item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
A label for the default data set. |
|
|
Specify the filename of the key art image to upload for the catalog item. |
GET /v4/catalog-item/{id}/keyart/url
/v4/catalog-item/{id}/keyart/url
Get a direct URL to the key art image for a catalog item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/catalog-item/{id}/overwrite-parties
/v4/catalog-item/{id}/overwrite-parties
Overwrite the existing parties associated with a catalog item with a new set of party IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of party IDs to overwrite the existing parties associated with the catalog item. |
GET /v4/catalog-item/{id}/rights-in-hierarchy
/v4/catalog-item/{id}/rights-in-hierarchy
Retrieve the rights in the hierarchy for a catalog item, with optional pagination.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the starting index for paginated results when retrieving rights in hierarchy. |
|
|
Specifies the number of rows to return per page. Provide an integer value. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/catalog-item/{id}/switch-template
/v4/catalog-item/{id}/switch-template
Switch the template applied to a catalog item, changing its structure and fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/catalog-item/{id}/switch-template-check
/v4/catalog-item/{id}/switch-template-check
Validate whether switching the template on a catalog item is allowed without applying the change.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/catalog-item/{id}/validation-errors
/v4/catalog-item/{id}/validation-errors
Retrieve a list of validation errors for a catalog item, showing data inconsistencies or missing required fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Contact (26)
POST /v4/contact
/v4/contact
Create a new contact record in the Rightsline system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/contact-processes
/v4/contact-processes
Retrieve a list of all contact processes available in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact-statuses/{templateId}
/v4/contact-statuses/{templateId}
Retrieve the list of statuses associated with a specific contact template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact-templates
/v4/contact-templates
Retrieve a list of all contact templates defined in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact-templates/{id}
/v4/contact-templates/{id}
Retrieve the details of a specific contact template by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact-templates/{id}/{tagLabel}
/v4/contact-templates/{id}/{tagLabel}
Retrieve a specific tag and its label from a contact template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/contact/search
/v4/contact/search
Search for contacts using a POST request with search criteria in the body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/contact/search-count
/v4/contact/search-count
Retrieve the count of contacts matching the provided search criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/contact/search-deleted
/v4/contact/search-deleted
Search for deleted contacts using a POST request with search criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/contact/{id}
/v4/contact/{id}
Permanently delete a specific contact by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}
/v4/contact/{id}
Retrieve the details of a specific contact by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/contact/{id}
/v4/contact/{id}
Update the details of an existing contact record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/contact/{id}/audit-history
/v4/contact/{id}/audit-history
Retrieve the audit history entries for a specific contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}/audit-history-detail
/v4/contact/{id}/audit-history-detail
Retrieve detailed audit history information for a specific contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}/copy-warnings
/v4/contact/{id}/copy-warnings
Retrieve any copy warnings associated with a specific contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}/date-alerts
/v4/contact/{id}/date-alerts
Retrieve date alerts configured for a specific contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}/date-math
/v4/contact/{id}/date-math
Perform date math calculations for a specific contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}/delete-check
/v4/contact/{id}/delete-check
Check whether a specific contact can be deleted without errors.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specifies the number of records to skip for paginated results. Provide an integer value. |
|
|
Specifies the number of rows to return per page. Provide an integer value. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}/draft-templates
/v4/contact/{id}/draft-templates
Retrieve draft document templates associated with a specific contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/contact/{id}/execute-document-workflow-action/{actionID}
/v4/contact/{id}/execute-document-workflow-action/{actionID}
Execute a specified document workflow action for a contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/contact/{id}/execute-signature-workflow-action/{actionID}
/v4/contact/{id}/execute-signature-workflow-action/{actionID}
Execute a specified signature workflow action for a contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/contact/{id}/execute-workflow-action/{actionID}
/v4/contact/{id}/execute-workflow-action/{actionID}
Executes a specified workflow action on a contact identified by ID. Use this to trigger a workflow step for a given contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/contact/{id}/get-lov-friendly-string/{tagLabel}
/v4/contact/{id}/get-lov-friendly-string/{tagLabel}
Retrieves the friendly string representation for a list-of-values (LOV) tag associated with a contact. Use this to get human-readable labels for LOV fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/contact/{id}/switch-template
/v4/contact/{id}/switch-template
Switches the template used for a contact's display or data entry. Use this to change the form layout for a specific contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/contact/{id}/switch-template-check
/v4/contact/{id}/switch-template-check
Checks whether switching a contact's template is allowed without actually performing the switch. Use this to validate a template change before executing it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/contact/{id}/validation-errors
/v4/contact/{id}/validation-errors
Retrieves validation errors for a specific contact. Use this to see what issues exist with the contact's data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Currency (5)
POST /v4/currency/conversion
/v4/currency/conversion
Creates or updates a currency conversion record with the specified parameters. Use this to define exchange rates between currencies.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
External identifier for the conversion record. |
|
|
Unique identifier for the currency conversion. |
|
|
The base currency code used by the company. |
|
|
The target currency code for the conversion. |
|
|
The group-level currency code for multi-currency setups. |
|
|
The exchange rate multiplier for the conversion. |
|
|
The date on which the conversion rate becomes effective. |
|
|
Numeric code indicating the type of conversion. |
|
|
Whether to apply the new currency configuration. |
GET /v4/currency/conversion/list
/v4/currency/conversion/list
Retrieves a list of all currency conversion records. Use this to view available exchange rates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE /v4/currency/conversion/{id}
/v4/currency/conversion/{id}
Permanently deletes a specific currency conversion record by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the currency conversion to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/currency/conversion/{id}
/v4/currency/conversion/{id}
Retrieves the details of a specific currency conversion record by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the currency conversion to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/currency/conversion/{id}
/v4/currency/conversion/{id}
Update a currency conversion rate for the specified conversion ID. Use this action to modify an existing currency conversion entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the currency conversion to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
External identifier for the conversion record. |
|
|
Unique identifier for the currency conversion. |
|
|
The base currency code used by the company. |
|
|
The target currency code for the conversion. |
|
|
The group-level currency code for multi-currency setups. |
|
|
The exchange rate multiplier for the conversion. |
|
|
The date on which the conversion rate becomes effective. |
|
|
Numeric code indicating the type of conversion. |
|
|
Whether to apply the new currency configuration. |
Date-math (3)
POST /v4/date-math
/v4/date-math
Create a new date-math calculation that performs arithmetic on dates. Use this action to define a custom date calculation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/date-math
/v4/date-math
Update an existing date-math calculation. Use this action to modify the parameters of a previously defined date calculation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE /v4/date-math/{dateMathCalcId}
/v4/date-math/{dateMathCalcId}
Permanently delete a specific date-math calculation by its unique identifier. Use this action to remove a date calculation that is no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique numeric identifier of the date-math calculation to delete. Provide this value as an integer. |
|
|
The response format expected from the API (e.g. application/json). |
Deal (34)
POST /v4/deal
/v4/deal
Create a new deal record. Use this action to add a deal to the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/deal-processes
/v4/deal-processes
Retrieve a list of all deal processes. Use this action to view the available deal process definitions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal-statuses/{templateId}
/v4/deal-statuses/{templateId}
Retrieve the statuses associated with a specific deal template. Use this action to get the list of statuses for a given template ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal-templates
/v4/deal-templates
Retrieve a list of all deal templates. Use this action to view the available templates for deals.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal-templates/{id}
/v4/deal-templates/{id}
Retrieve details of a specific deal template by its unique identifier. Use this action to get information about a single template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal-templates/{id}/{tagLabel}
/v4/deal-templates/{id}/{tagLabel}
Retrieve a specific tag label within a deal template. Use this action to get the details of a tag by template ID and tag label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/deal/data-default
/v4/deal/data-default
Create a new default data set for deals. Use this action to define default values that apply to deal records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
DELETE /v4/deal/data-default/{setGuid}
/v4/deal/data-default/{setGuid}
Permanently delete a default data set identified by its GUID. Use this action to remove a default data set that is no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The GUID of the default data set to delete. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/deal/search
/v4/deal/search
Search for deals using custom criteria. Use this action to find deals matching specific search parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/deal/search-count
/v4/deal/search-count
Count the number of deals matching the search criteria provided in the request body. Use this action to obtain a total count before retrieving results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/deal/search-deleted
/v4/deal/search-deleted
Search for and retrieve a list of deleted deals based on the criteria provided in the request body. Use this action to locate deals that have been soft-deleted.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/deal/{id}
/v4/deal/{id}
Permanently delete a specific deal identified by its unique ID. Use this action to remove a deal from the system entirely.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal/{id}
/v4/deal/{id}
Retrieve the details of a specific deal by its unique ID. Use this action to get full information about a single deal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/deal/{id}
/v4/deal/{id}
Update the details of an existing deal identified by its unique ID. Use this action to modify deal attributes by providing the updated data in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/deal/{id}/audit-history
/v4/deal/{id}/audit-history
Retrieve the audit history for a specific deal by its unique ID. Use this action to see a log of changes made to the deal over time.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal/{id}/audit-history-detail
/v4/deal/{id}/audit-history-detail
Retrieve the audit history details for a specific deal, showing all changes made over time.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/deal/{id}/calculate-allocations
/v4/deal/{id}/calculate-allocations
Calculate financial allocations for a deal based on specified dimensions and distribution methods.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The rights dimension identifier to use for allocation calculations. |
|
|
The catalog distribution method to apply when calculating allocations. |
|
|
The hierarchy distribution method to apply when calculating allocations. |
|
|
Indicates whether to roll up allocations to a single amount. |
GET /v4/deal/{id}/conflicts
/v4/deal/{id}/conflicts
List all conflicts associated with a specific deal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the starting index for paginated results when retrieving rights in hierarchy. |
|
|
Specifies the number of rows to return per page. Provide an integer value. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal/{id}/conflicts/{conflictId}
/v4/deal/{id}/conflicts/{conflictId}
Retrieve detailed information about a specific conflict for a deal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The unique identifier of the conflict to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/deal/{id}/conflicts/{conflictId}
/v4/deal/{id}/conflicts/{conflictId}
Update the blocker status and reason for change for a specific conflict in a deal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The unique identifier of the conflict to update. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
Whether the conflict should be marked as a blocker. |
|
|
The reason for changing the conflict status. |
GET /v4/deal/{id}/copy-warnings
/v4/deal/{id}/copy-warnings
Retrieve warnings that may appear when copying a deal, such as missing data or configuration issues.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal/{id}/data-default
/v4/deal/{id}/data-default
Retrieve the default data values configured for a deal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/deal/{id}/data-default
/v4/deal/{id}/data-default
Set or update the default data values for a deal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
GET /v4/deal/{id}/date-alerts
/v4/deal/{id}/date-alerts
Retrieve date-related alerts for a deal, such as upcoming deadlines or expirations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal/{id}/date-math
/v4/deal/{id}/date-math
Perform date calculations and retrieve computed dates based on the deal's schedule.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal/{id}/draft-templates
/v4/deal/{id}/draft-templates
Retrieve draft templates available for a deal, used for generating document drafts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/deal/{id}/execute-document-workflow-action/{actionID}
/v4/deal/{id}/execute-document-workflow-action/{actionID}
Execute a specific document workflow action on a deal, such as approving or rejecting a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/deal/{id}/execute-signature-workflow-action/{actionID}
/v4/deal/{id}/execute-signature-workflow-action/{actionID}
Execute a specified signature workflow action on a deal. Use this to trigger signature-related workflow steps such as sending for signature or approving a signature.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/deal/{id}/execute-workflow-action/{actionID}
/v4/deal/{id}/execute-workflow-action/{actionID}
Execute a specified workflow action on a deal. Use this to advance a deal through its workflow by performing actions like submit, approve, or reject.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/deal/{id}/get-lov-friendly-string/{tagLabel}
/v4/deal/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly display string for a list-of-values tag associated with a deal. Use this to translate internal tag values into human-readable labels.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/deal/{id}/overwrite-parties
/v4/deal/{id}/overwrite-parties
Overwrite the parties associated with a deal. Use this to replace all existing parties on the deal with a new set of party data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of party IDs to overwrite the existing parties associated with the catalog item. |
POST /v4/deal/{id}/switch-template
/v4/deal/{id}/switch-template
Switch the template of an existing deal to a different template. Use this to change the deal's structure while preserving its data where possible.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/deal/{id}/switch-template-check
/v4/deal/{id}/switch-template-check
Validate whether a deal can be switched to a different template without performing the switch. Use this to preview potential issues before applying a template change.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/deal/{id}/validation-errors
/v4/deal/{id}/validation-errors
Retrieve validation errors for a deal. Use this to identify data issues that prevent the deal from being processed or saved.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
File (31)
POST /v4/file
/v4/file
Upload a new file to Rightsline.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/file-processes
/v4/file-processes
Retrieve a list of file processing jobs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file-statuses/{templateId}
/v4/file-statuses/{templateId}
Retrieve the status of file uploads for a specific template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file-templates
/v4/file-templates
Retrieve a list of available file upload templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file-templates/{id}
/v4/file-templates/{id}
Retrieve details of a specific file upload template by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file-templates/{id}/{tagLabel}
/v4/file-templates/{id}/{tagLabel}
Retrieve a specific tag label within a file upload template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/file/search
/v4/file/search
Search for files using specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/file/search-count
/v4/file/search-count
Get the count of files matching a search query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/file/search-deleted
/v4/file/search-deleted
Search for deleted files.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/file/{id}
/v4/file/{id}
Permanently delete a file by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}
/v4/file/{id}
Retrieve details of a specific file by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/file/{id}
/v4/file/{id}
Update or create a file resource at the specified identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
DELETE /v4/file/{id}-{revisionId}
/v4/file/{id}-{revisionId}
Permanently delete a specific revision of a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}-{revisionId}
/v4/file/{id}-{revisionId}
Retrieve the metadata for a specific revision of a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}-{revisionId}/data
/v4/file/{id}-{revisionId}/data
Download the binary data for a specific revision of a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}-{revisionId}/url
/v4/file/{id}-{revisionId}/url
Generate a temporary URL that provides direct access to a specific file revision's data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/audit-history
/v4/file/{id}/audit-history
Retrieve the audit history records associated with a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/audit-history-detail
/v4/file/{id}/audit-history-detail
Retrieve detailed audit history entries for a file, including field-level changes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/copy-warnings
/v4/file/{id}/copy-warnings
Retrieve any copy warnings that apply to a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/data
/v4/file/{id}/data
Download the latest binary data of a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/date-alerts
/v4/file/{id}/date-alerts
Retrieve date alerts configured for a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/draft-templates
/v4/file/{id}/draft-templates
Retrieve draft templates that are available for a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/file/{id}/execute-document-workflow-action/{actionID}
/v4/file/{id}/execute-document-workflow-action/{actionID}
Execute a document workflow action on a specific file using the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/file/{id}/execute-signature-workflow-action/{actionID}
/v4/file/{id}/execute-signature-workflow-action/{actionID}
Execute a signature workflow action on a specific file using the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/file/{id}/execute-workflow-action/{actionID}
/v4/file/{id}/execute-workflow-action/{actionID}
Execute a general workflow action on a specific file using the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/get-lov-friendly-string/{tagLabel}
/v4/file/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly string representation for a given tag label associated with a specific file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/revisions
/v4/file/{id}/revisions
Retrieve a list of all revisions for a specific file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/file/{id}/switch-template
/v4/file/{id}/switch-template
Switch the template used by a specific file to a different template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/file/{id}/switch-template-check
/v4/file/{id}/switch-template-check
Check whether a specific file can be switched to a different template without errors.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/file/{id}/url
/v4/file/{id}/url
Retrieve the URL for a specific file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/file/{id}/validation-errors
/v4/file/{id}/validation-errors
Retrieve all validation errors for a specific file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Financial-document (25)
POST /v4/financial-document
/v4/financial-document
Create a new financial document in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/financial-document-processes
/v4/financial-document-processes
Retrieve a list of financial document processes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document-statuses/{templateId}
/v4/financial-document-statuses/{templateId}
Retrieve the statuses available for a specific financial document template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document-templates
/v4/financial-document-templates
Retrieve a list of all financial document templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document-templates/{id}
/v4/financial-document-templates/{id}
Retrieve details of a specific financial document template by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document-templates/{id}/{tagLabel}
/v4/financial-document-templates/{id}/{tagLabel}
Retrieve a specific tag label associated with a given financial document template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/financial-document/search
/v4/financial-document/search
Search for financial documents using the provided criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/financial-document/search-count
/v4/financial-document/search-count
Get the count of financial documents that match the given search criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/financial-document/search-deleted
/v4/financial-document/search-deleted
Search for deleted financial documents using the provided criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/financial-document/{id}
/v4/financial-document/{id}
Permanently delete a financial document by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document/{id}
/v4/financial-document/{id}
Retrieve a specific financial document by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/financial-document/{id}
/v4/financial-document/{id}
Update an existing financial document identified by its unique ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/financial-document/{id}/audit-history
/v4/financial-document/{id}/audit-history
Retrieve the audit history for a specific financial document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document/{id}/audit-history-detail
/v4/financial-document/{id}/audit-history-detail
Retrieve detailed audit history entries for a specific financial document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document/{id}/copy-warnings
/v4/financial-document/{id}/copy-warnings
Retrieve any warnings that would be generated when copying the specified financial document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document/{id}/date-alerts
/v4/financial-document/{id}/date-alerts
Retrieve date-related alerts for the specified financial document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document/{id}/draft-templates
/v4/financial-document/{id}/draft-templates
Retrieve available draft templates for the specified financial document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/financial-document/{id}/execute-document-workflow-action/{actionID}
/v4/financial-document/{id}/execute-document-workflow-action/{actionID}
Execute a specific document workflow action on the financial document identified by the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/financial-document/{id}/execute-signature-workflow-action/{actionID}
/v4/financial-document/{id}/execute-signature-workflow-action/{actionID}
Execute a specific signature workflow action on the financial document identified by the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/financial-document/{id}/execute-workflow-action/{actionID}
/v4/financial-document/{id}/execute-workflow-action/{actionID}
Execute a specific workflow action on the financial document identified by the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/financial-document/{id}/get-lov-friendly-string/{tagLabel}
/v4/financial-document/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly display string for a list-of-values tag label associated with the financial document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/financial-document/{id}/overwrite-parties
/v4/financial-document/{id}/overwrite-parties
Overwrite the parties associated with a financial document, replacing the existing set with the provided data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of party IDs to overwrite the existing parties associated with the catalog item. |
POST /v4/financial-document/{id}/switch-template
/v4/financial-document/{id}/switch-template
Switch the template of a financial document to a different template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/financial-document/{id}/switch-template-check
/v4/financial-document/{id}/switch-template-check
Check whether switching the template of a financial document is possible without performing the switch.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/financial-document/{id}/validation-errors
/v4/financial-document/{id}/validation-errors
Retrieve a list of validation errors for a financial document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Financial-periods (7)
GET /v4/financial-periods
/v4/financial-periods
Retrieve a list of all financial periods.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/financial-periods
/v4/financial-periods
Create a new financial period for a given year and period number.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The year for the new financial period, provided as an integer. |
|
|
The period number within the year for the new financial period, provided as an integer. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
GET /v4/financial-periods-settings
/v4/financial-periods-settings
Retrieve the current financial periods settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/financial-periods-settings
/v4/financial-periods-settings
Update the financial periods settings with the provided configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The name of the process to associate with the financial periods settings. |
|
|
The identifier of the process to associate with the financial periods settings. |
|
|
The identifier of the action to associate with the financial periods settings. |
|
|
The name of the action to associate with the financial periods settings. |
DELETE /v4/financial-periods/{id}
/v4/financial-periods/{id}
Permanently delete a specific financial period by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/financial-periods/{id}
/v4/financial-periods/{id}
Update an existing financial period by its unique identifier. Use this action when you need to modify the details of a specific financial period.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The year for the new financial period, provided as an integer. |
|
|
The period number within the year for the new financial period, provided as an integer. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
PUT /v4/financial-periods/{id}/close
/v4/financial-periods/{id}/close
Close a financial period by its unique identifier. Use this action when you need to finalize a financial period so no further changes can be made.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Inventory (34)
POST /v4/inventory
/v4/inventory
Create a new inventory record. Use this action when you need to add a new item to the inventory system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/inventory-processes
/v4/inventory-processes
Retrieve a list of all inventory processes. Use this action when you need to see the available processes for inventory operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory-statuses/{templateId}
/v4/inventory-statuses/{templateId}
Retrieve inventory statuses associated with a specific template. Use this action when you need the list of statuses for a given inventory template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory-templates
/v4/inventory-templates
Retrieve all available inventory templates. Use this action when you need to list the templates used for inventory configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory-templates/{id}
/v4/inventory-templates/{id}
Retrieve a specific inventory template by its unique identifier. Use this action when you need details of a particular template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory-templates/{id}/{tagLabel}
/v4/inventory-templates/{id}/{tagLabel}
Retrieve a specific tag label within an inventory template. Use this action when you need details of a particular tag for a given template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/inventory/data-default
/v4/inventory/data-default
Create a default data set for inventory records. Use this action when you need to set up default values that apply to new inventory entries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
DELETE /v4/inventory/data-default/{setGuid}
/v4/inventory/data-default/{setGuid}
Delete a default data set by its globally unique identifier. Use this action when you need to remove a previously created default data set.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The GUID of the default data set to delete. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/inventory/search
/v4/inventory/search
Search for inventory records based on specified criteria. Use this action when you need to find inventory items matching custom filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/inventory/search-count
/v4/inventory/search-count
Get the count of inventory records that match search criteria. Use this action when you need the number of results without retrieving the full data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/inventory/search-deleted
/v4/inventory/search-deleted
Search for inventory items that have been marked as deleted. Use this to find and review records that were previously removed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/inventory/{id}
/v4/inventory/{id}
Permanently delete an inventory item using its unique identifier. This action cannot be undone.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}
/v4/inventory/{id}
Retrieve the full details of an inventory item by its unique identifier. Use this to view current data for a single record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/inventory/{id}
/v4/inventory/{id}
Update the properties of an existing inventory item using its unique identifier. Supply the fields you wish to modify.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/inventory/{id}/audit-history
/v4/inventory/{id}/audit-history
Retrieve the audit history for an inventory item, showing a log of changes made over time. Use this to track modifications to the record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}/audit-history-detail
/v4/inventory/{id}/audit-history-detail
Retrieve detailed audit history entries for an inventory item, including field-level changes. Use this to see exactly what was altered in each audit event.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}/copy-warnings
/v4/inventory/{id}/copy-warnings
Retrieve any copy-related warnings for an inventory item, such as conflicts or issues that might arise when duplicating the record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}/data-default
/v4/inventory/{id}/data-default
Retrieve the default data configuration for a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/inventory/{id}/data-default
/v4/inventory/{id}/data-default
Create or update the default data configuration for a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
GET /v4/inventory/{id}/date-alerts
/v4/inventory/{id}/date-alerts
Retrieve date alerts associated with a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}/date-math
/v4/inventory/{id}/date-math
Perform date math calculations for a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}/draft-templates
/v4/inventory/{id}/draft-templates
Retrieve draft templates associated with a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/inventory/{id}/execute-document-workflow-action/{actionID}
/v4/inventory/{id}/execute-document-workflow-action/{actionID}
Execute a document workflow action identified by actionID on a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/inventory/{id}/execute-signature-workflow-action/{actionID}
/v4/inventory/{id}/execute-signature-workflow-action/{actionID}
Execute a signature workflow action identified by actionID on a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/inventory/{id}/execute-workflow-action/{actionID}
/v4/inventory/{id}/execute-workflow-action/{actionID}
Execute a general workflow action identified by actionID on a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}/get-lov-friendly-string/{tagLabel}
/v4/inventory/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly string representation for a list-of-values tag label on a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE /v4/inventory/{id}/keyart
/v4/inventory/{id}/keyart
Permanently delete the keyart image associated with a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/inventory/{id}/keyart
/v4/inventory/{id}/keyart
Retrieve the keyart image associated with a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/inventory/{id}/keyart
/v4/inventory/{id}/keyart
Upload or update the keyart image for a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
A label for the default data set. |
|
|
Specify the filename of the key art image to upload for the catalog item. |
GET /v4/inventory/{id}/keyart/url
/v4/inventory/{id}/keyart/url
Retrieve the URL for the keyart image associated with a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/inventory/{id}/overwrite-parties
/v4/inventory/{id}/overwrite-parties
Overwrite the parties associated with a specific inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of party IDs to overwrite the existing parties associated with the catalog item. |
POST /v4/inventory/{id}/switch-template
/v4/inventory/{id}/switch-template
Switch the template applied to the specified inventory item to a new template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/inventory/{id}/switch-template-check
/v4/inventory/{id}/switch-template-check
Validate whether the specified inventory item's template can be switched without actually performing the switch.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/inventory/{id}/validation-errors
/v4/inventory/{id}/validation-errors
Retrieve any validation errors associated with the specified inventory item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Job (30)
POST /v4/job
/v4/job
Create a new job using the provided job configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/job-processes
/v4/job-processes
Retrieve a list of all available job processes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job-statuses/{templateId}
/v4/job-statuses/{templateId}
Retrieve the job statuses associated with the specified job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job-templates
/v4/job-templates
Retrieve a list of all job templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job-templates/{id}
/v4/job-templates/{id}
Retrieve details for the specified job template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job-templates/{id}/{tagLabel}
/v4/job-templates/{id}/{tagLabel}
Retrieve details for a job template identified by its ID and a specific tag label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/job/data-default
/v4/job/data-default
Create a new job with default settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
DELETE /v4/job/data-default/{setGuid}
/v4/job/data-default/{setGuid}
Permanently delete a default data job identified by its set GUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The GUID of the default data set to delete. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/job/search
/v4/job/search
Search for jobs based on specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/job/search-count
/v4/job/search-count
Retrieve the count of jobs matching the search criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/job/search-deleted
/v4/job/search-deleted
Search for deleted jobs based on specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/job/{id}
/v4/job/{id}
Permanently delete a job by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job/{id}
/v4/job/{id}
Retrieve details of a specific job by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/job/{id}
/v4/job/{id}
Update an existing job identified by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/job/{id}/audit-history
/v4/job/{id}/audit-history
Retrieve the audit history for a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job/{id}/audit-history-detail
/v4/job/{id}/audit-history-detail
Retrieve detailed audit history entries for a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job/{id}/copy-warnings
/v4/job/{id}/copy-warnings
Retrieve copy warnings associated with a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job/{id}/data-default
/v4/job/{id}/data-default
Retrieve the data default configuration for a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/job/{id}/data-default
/v4/job/{id}/data-default
Create or update the data default configuration for a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
GET /v4/job/{id}/date-alerts
/v4/job/{id}/date-alerts
Retrieve date alerts for a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job/{id}/date-math
/v4/job/{id}/date-math
Retrieve date math calculations for a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job/{id}/draft-templates
/v4/job/{id}/draft-templates
Retrieve draft templates associated with a specific job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/job/{id}/execute-document-workflow-action/{actionID}
/v4/job/{id}/execute-document-workflow-action/{actionID}
Execute a document workflow action for a specific job using the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/job/{id}/execute-signature-workflow-action/{actionID}
/v4/job/{id}/execute-signature-workflow-action/{actionID}
Execute a signature workflow action for a specified job, triggering the next step in the signature process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/job/{id}/execute-workflow-action/{actionID}
/v4/job/{id}/execute-workflow-action/{actionID}
Execute a workflow action for a specified job, advancing the job through its workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/job/{id}/get-lov-friendly-string/{tagLabelv}
/v4/job/{id}/get-lov-friendly-string/{tagLabelv}
Retrieve the friendly display string for a list-of-values tag label associated with a job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The tag label whose friendly string should be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/job/{id}/overwrite-parties
/v4/job/{id}/overwrite-parties
Overwrite the parties associated with a job, replacing existing party data with new values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of party IDs to overwrite the existing parties associated with the catalog item. |
POST /v4/job/{id}/switch-template
/v4/job/{id}/switch-template
Switch the template used by a job to a different template, initiating the template change process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/job/{id}/switch-template-check
/v4/job/{id}/switch-template-check
Check whether switching the template for a job is allowed, returning validation results without making the change.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/job/{id}/validation-errors
/v4/job/{id}/validation-errors
Retrieve a list of validation errors for a job, indicating issues that must be resolved before the job can proceed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Processes (4)
GET /v4/processes/{processID}/actions
/v4/processes/{processID}/actions
Retrieve a list of available actions for a specified process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the process whose actions are being queried. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/processes/{processID}/actions/{actionID}
/v4/processes/{processID}/actions/{actionID}
Retrieve details of a specific action within a process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the process that contains the action. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/processes/{processID}/notifications
/v4/processes/{processID}/notifications
Retrieve a list of notifications associated with a specific process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the process that contains the action. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/processes/{processID}/statuses
/v4/processes/{processID}/statuses
Retrieve a list of statuses associated with a specific process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the process that contains the action. |
|
|
The response format expected from the API (e.g. application/json). |
Project (30)
POST /v4/project
/v4/project
Create a new project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/project-processes
/v4/project-processes
Retrieve a list of project processes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project-statuses/{templateId}
/v4/project-statuses/{templateId}
Retrieve statuses for a given project template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project-templates
/v4/project-templates
Retrieve a list of project templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project-templates/{id}
/v4/project-templates/{id}
Retrieve details of a specific project template by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project-templates/{id}/{tagLabel}
/v4/project-templates/{id}/{tagLabel}
Retrieve a specific tag label from a project template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/project/data-default
/v4/project/data-default
Create or update default project data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
DELETE /v4/project/data-default/{setGuid}
/v4/project/data-default/{setGuid}
Delete a default data set identified by its GUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The GUID of the default data set to delete. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/project/search
/v4/project/search
Search for projects using specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/project/search-count
/v4/project/search-count
Get the count of projects matching a search query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/project/search-deleted
/v4/project/search-deleted
Search for deleted projects. Use this action to find projects that have been marked as deleted, typically for recovery or audit purposes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/project/{id}
/v4/project/{id}
Permanently delete a specific project by its unique identifier. Use this action to remove a project from the system entirely.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project/{id}
/v4/project/{id}
Retrieve the details of a single project using its unique identifier. Use this action to fetch project data for viewing or editing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/project/{id}
/v4/project/{id}
Update an existing project by providing new data for the specified project identifier. Use this action to modify project properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/project/{id}/audit-history
/v4/project/{id}/audit-history
Retrieve the audit history for a specific project. Use this action to view a log of changes made to the project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project/{id}/audit-history-detail
/v4/project/{id}/audit-history-detail
Retrieve detailed audit history entries for a specific project. Use this action to see granular information about each change recorded in the audit log.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project/{id}/copy-warnings
/v4/project/{id}/copy-warnings
Retrieve copy-related warnings for a specific project. Use this action to check for potential issues before duplicating the project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project/{id}/data-default
/v4/project/{id}/data-default
Retrieves the default data values configured for the specified project, useful for pre-populating forms or understanding baseline settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/project/{id}/data-default
/v4/project/{id}/data-default
Creates or updates the default data values for the specified project, allowing you to set baseline fields that will be applied to new records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
GET /v4/project/{id}/date-alerts
/v4/project/{id}/date-alerts
Returns date-related alerts or notifications for the specified project, such as upcoming deadlines or expirations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project/{id}/date-math
/v4/project/{id}/date-math
Performs date calculations or retrieves computed date values relative to the specified project's timeline.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project/{id}/draft-templates
/v4/project/{id}/draft-templates
Lists the draft templates available for the specified project, which can be used to create new documents based on predefined structures.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/project/{id}/execute-document-workflow-action/{actionID}
/v4/project/{id}/execute-document-workflow-action/{actionID}
Executes a specific document workflow action identified by actionID on the project, advancing the document through its workflow steps.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/project/{id}/execute-signature-workflow-action/{actionID}
/v4/project/{id}/execute-signature-workflow-action/{actionID}
Executes a specific signature workflow action identified by actionID on the project, triggering signature-related processes like sending for signature or approving.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/project/{id}/execute-workflow-action/{actionID}
/v4/project/{id}/execute-workflow-action/{actionID}
Executes a general workflow action identified by actionID on the project, performing a predefined operation within the project's workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/project/{id}/get-lov-friendly-string/{tagLabel}
/v4/project/{id}/get-lov-friendly-string/{tagLabel}
Retrieves the friendly (display) string for a list-of-values tag identified by tagLabel within the project, translating a code to a human-readable label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/project/{id}/overwrite-parties
/v4/project/{id}/overwrite-parties
Overwrites the party (contact) information associated with the project, replacing existing party data with the provided payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of party IDs to overwrite the existing parties associated with the catalog item. |
POST /v4/project/{id}/switch-template
/v4/project/{id}/switch-template
Switches the project to use a different template, updating its structure and fields based on the new template configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/project/{id}/switch-template-check
/v4/project/{id}/switch-template-check
Check whether switching the project's template is possible without causing validation errors.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/project/{id}/validation-errors
/v4/project/{id}/validation-errors
Retrieve a list of validation errors associated with a project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Relationship (8)
GET /v4/relationship
/v4/relationship
Retrieve a list of all relationships in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/relationship
/v4/relationship
Create a new relationship between a parent and a child record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The character type ID of the parent record. |
|
|
The ID of the parent record. |
|
|
The character type ID of the child record. |
|
|
The ID of the child record. |
|
|
The sequence number to assign to the relationship. |
GET /v4/relationship-types
/v4/relationship-types
Retrieve a list of all available relationship types.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/relationship/search
/v4/relationship/search
Search for relationships based on criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/relationship/search-count
/v4/relationship/search-count
Get the count of relationships matching the search criteria in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/relationship/search-deleted
/v4/relationship/search-deleted
Search for deleted relationships using optional filter parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
Filter by the parent character type ID. |
|
|
Filter by the parent record ID. |
|
|
Filter by the child character type ID. |
|
|
Filter by the child record ID. |
|
|
Filter by the relationship record indicator. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter by the character type ID for a custom filter. |
|
|
Filter by the character field name for a custom filter. |
|
|
Filter by the character field value for a custom filter. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
DELETE /v4/relationship/{id}
/v4/relationship/{id}
Permanently delete a specific relationship record by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/relationship/{id}
/v4/relationship/{id}
Retrieve details of a specific relationship using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique numeric identifier of the relationship to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
Relative-rights-profile (2)
GET /v4/relative-rights-profile
/v4/relative-rights-profile
Retrieve a list of all relative rights profiles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/relative-rights-profile
/v4/relative-rights-profile
Create a new relative rights profile with optional deal and catalog associations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The identifier of the deal to associate with the new profile. |
|
|
An array of catalog identifiers to include in the profile. |
Right (25)
POST /v4/right
/v4/right
Create a new right record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/right-processes
/v4/right-processes
Retrieve a list of all right processes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right-statuses/{templateId}
/v4/right-statuses/{templateId}
Retrieve the statuses available for a specific rights template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right-templates
/v4/right-templates
Retrieve a list of all right templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right-templates/{id}
/v4/right-templates/{id}
Retrieve details of a specific right template by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right-templates/{id}/{tagLabel}
/v4/right-templates/{id}/{tagLabel}
Retrieve details of a specific right template using its identifier and tag label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/right/search
/v4/right/search
Search for rights using a query payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/right/search-count
/v4/right/search-count
Get the count of rights that match a search query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/right/search-deleted
/v4/right/search-deleted
Search for rights that have been marked as deleted. Use this action to locate and review previously deleted records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/right/{id}
/v4/right/{id}
Permanently delete a specific right record by its unique identifier. Use this action to remove a right that is no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right/{id}
/v4/right/{id}
Retrieve the details of a specific right record using its unique identifier. Use this action to view or verify right information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/right/{id}
/v4/right/{id}
Update an existing right record with new values by specifying its unique identifier. Use this action to modify right properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/right/{id}/audit-history
/v4/right/{id}/audit-history
Retrieve the audit history for a specific right record, showing a log of changes made over time. Use this action to track modifications.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right/{id}/audit-history-detail
/v4/right/{id}/audit-history-detail
Retrieve detailed audit trail entries for a specific right record, including before and after values. Use this action to examine specific changes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right/{id}/copy-warnings
/v4/right/{id}/copy-warnings
Retrieve any warnings or conflicts that may arise when copying a specific right record. Use this action to preview potential issues before copying.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right/{id}/date-alerts
/v4/right/{id}/date-alerts
Retrieve date alerts associated with a specific right. Use this action to view any alerts configured for the right's dates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right/{id}/date-math
/v4/right/{id}/date-math
Retrieve date math results for a specific right. Use this action to see computed date values based on the right's date expressions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right/{id}/draft-templates
/v4/right/{id}/draft-templates
Retrieve a list of draft templates available for a specific right. Use this action to view templates that can be applied to the right.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/right/{id}/execute-document-workflow-action/{actionID}
/v4/right/{id}/execute-document-workflow-action/{actionID}
Execute a document workflow action on a specific right. Use this action to trigger a document-related workflow step identified by actionID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/right/{id}/execute-signature-workflow-action/{actionID}
/v4/right/{id}/execute-signature-workflow-action/{actionID}
Execute a signature workflow action on a specific right. Use this action to trigger a signature-related workflow step identified by actionID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/right/{id}/execute-workflow-action/{actionID}
/v4/right/{id}/execute-workflow-action/{actionID}
Execute a generic workflow action on a specific right. Use this action to trigger a workflow step identified by actionID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/right/{id}/get-lov-friendly-string/{tagLabel}
/v4/right/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly display string for a list-of-values tag on a specific right. Use this action to get the human-readable label for the tag identified by tagLabel.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/right/{id}/switch-template
/v4/right/{id}/switch-template
Switch the template applied to a specific right. Use this action to change the right's template to a different one.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/right/{id}/switch-template-check
/v4/right/{id}/switch-template-check
Check whether a template switch is valid for a specific right. Use this action to validate the switch before applying it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/right/{id}/validation-errors
/v4/right/{id}/validation-errors
Retrieve validation errors for a specific right identified by its ID. Use this to inspect any issues or warnings associated with a right record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Royalty (25)
POST /v4/royalty
/v4/royalty
Create a new royalty record. Use this to add a royalty entry to the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/royalty-processes
/v4/royalty-processes
Retrieve a list of all royalty processes. Use this to view the available processing runs or jobs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty-statuses/{templateId}
/v4/royalty-statuses/{templateId}
Retrieve royalty statuses for a given template. Use this to see the status options associated with a specific royalty template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty-templates
/v4/royalty-templates
Retrieve a list of all royalty templates. Use this to see the available templates for royalty calculations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty-templates/{id}
/v4/royalty-templates/{id}
Retrieve details of a specific royalty template by its ID. Use this to view the configuration of a particular template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty-templates/{id}/{tagLabel}
/v4/royalty-templates/{id}/{tagLabel}
Retrieve a specific tag label within a royalty template. Use this to access the value or metadata of a particular tag.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/royalty/search
/v4/royalty/search
Search for royalty records using a query. Use this to find royalties matching specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/royalty/search-count
/v4/royalty/search-count
Get the count of royalty records matching a search query. Use this to determine the number of results without retrieving the full list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/royalty/search-deleted
/v4/royalty/search-deleted
Search for deleted royalty records. Use this to find royalties that have been previously removed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/royalty/{id}
/v4/royalty/{id}
Permanently delete a specific royalty record by its ID. Use this to remove a royalty entry from the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty/{id}
/v4/royalty/{id}
Retrieve details of a specific royalty record by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/royalty/{id}
/v4/royalty/{id}
Update an existing royalty record identified by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/royalty/{id}/audit-history
/v4/royalty/{id}/audit-history
Retrieve the audit history for a specific royalty record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty/{id}/audit-history-detail
/v4/royalty/{id}/audit-history-detail
Retrieve detailed audit history entries for a specific royalty record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty/{id}/copy-warnings
/v4/royalty/{id}/copy-warnings
Retrieve copy warnings associated with a specific royalty record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty/{id}/date-alerts
/v4/royalty/{id}/date-alerts
Retrieve date alerts for a specific royalty record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty/{id}/date-math
/v4/royalty/{id}/date-math
Perform or retrieve date math calculations for a specific royalty record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty/{id}/draft-templates
/v4/royalty/{id}/draft-templates
Retrieve draft templates associated with a specific royalty record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/royalty/{id}/execute-document-workflow-action/{actionID}
/v4/royalty/{id}/execute-document-workflow-action/{actionID}
Execute a document workflow action on a specific royalty record using the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/royalty/{id}/execute-signature-workflow-action/{actionID}
/v4/royalty/{id}/execute-signature-workflow-action/{actionID}
Execute a signature workflow action on a specific royalty record using the given action ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/royalty/{id}/execute-workflow-action/{actionID}
/v4/royalty/{id}/execute-workflow-action/{actionID}
Execute a workflow action on a specific royalty record using the action's unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/royalty/{id}/get-lov-friendly-string/{tagLabel}
/v4/royalty/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly display string for a given list-of-values tag label associated with a royalty record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/royalty/{id}/switch-template
/v4/royalty/{id}/switch-template
Switch the template applied to a specific royalty record to a different one.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/royalty/{id}/switch-template-check
/v4/royalty/{id}/switch-template-check
Check whether switching the template on a royalty record is valid and will not cause errors.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/royalty/{id}/validation-errors
/v4/royalty/{id}/validation-errors
Get all validation errors for a specific royalty record to identify data issues.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Schedule (8)
POST /v4/schedule
/v4/schedule
Create a new schedule entry in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
POST /v4/schedule/search-count
/v4/schedule/search-count
Return the count of schedule entries that match a search query without retrieving the full list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
DELETE /v4/schedule/{id}
/v4/schedule/{id}
Permanently delete a schedule by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/schedule/{id}
/v4/schedule/{id}
Retrieve the details of a specific schedule using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/schedule/{id}
/v4/schedule/{id}
Update an existing schedule identified by its unique identifier with the provided data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/schedule/{id}/audit-history
/v4/schedule/{id}/audit-history
Retrieve the audit history for a specific schedule identified by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/schedule/{id}/audit-history-detail
/v4/schedule/{id}/audit-history-detail
Retrieve detailed audit history entries for a specific schedule identified by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/schedule/{id}/copy-warnings
/v4/schedule/{id}/copy-warnings
Retrieve copy warnings associated with a specific schedule identified by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
Sso (3)
DELETE /v4/sso/{id}
/v4/sso/{id}
Permanently delete an SSO configuration by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/sso/{id}
/v4/sso/{id}
Retrieve the details of a specific SSO configuration using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/sso/{id}
/v4/sso/{id}
Update an existing SSO configuration identified by its unique identifier with the provided optional parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The X.509 certificate content as a string for the SSO configuration. |
|
|
The SSO authentication XML payload as a string. |
|
|
The identity provider name as a string. |
|
|
The numeric identifier for the URL type. |
|
|
The URL associated with the SSO configuration as a string. |
Table (25)
POST /v4/table
/v4/table
Create a new table record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/table-processes
/v4/table-processes
Retrieve a list of table processes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table-statuses/{templateId}
/v4/table-statuses/{templateId}
Retrieve table statuses for a specific template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template whose statuses are to be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table-templates
/v4/table-templates
Retrieve a list of table templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table-templates/{id}
/v4/table-templates/{id}
Retrieve details of a specific table template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table-templates/{id}/{tagLabel}
/v4/table-templates/{id}/{tagLabel}
Retrieve a table template filtered by a tag label.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/table/search
/v4/table/search
Search for table records using provided criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/table/search-count
/v4/table/search-count
Get the count of table records matching search criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The keywords to search for within amount records. |
|
|
The starting index for paginated results. |
|
|
The number of rows to return per page. |
|
|
A cursor token for pagination through large result sets. |
|
|
An array of sort order definitions for the search results. |
POST /v4/table/search-deleted
/v4/table/search-deleted
Search for deleted table records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (16)
|
Option Name |
Description |
|---|---|
|
|
Filter results by the character type identifier. |
|
|
Filter results by the record identifier. |
|
|
Filter results to amounts deleted on or after this date. |
|
|
Filter results to amounts deleted on or before this date. |
|
|
Filter results by the identifier of the user who deleted the amount. |
|
|
Filter results by the template identifier. |
|
|
Filter results by the status identifier. |
|
|
Filter results to amounts created on or after this date. |
|
|
Filter results to amounts created on or before this date. |
|
|
Filter results by the identifier of the user who created the amount. |
|
|
Filter results to amounts updated on or after this date. |
|
|
Filter results to amounts updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the amount. |
|
|
Filter results to amounts whose status was updated on or after this date. |
|
|
Filter results to amounts whose status was updated on or before this date. |
|
|
Filter results by the identifier of the user who last updated the status. |
DELETE /v4/table/{id}
/v4/table/{id}
Permanently delete a table record by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table/{id}
/v4/table/{id}
Retrieve details of a specific table record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the revision identifier to retrieve a particular version of the amount. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/table/{id}
/v4/table/{id}
Updates an existing table identified by its ID. Use this action to modify table properties or content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Indicates whether to include extended data in the search results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
GET /v4/table/{id}/audit-history
/v4/table/{id}/audit-history
Retrieves the audit history for a specific table. Use this action to review changes made to the table over time.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter audit records by the identifier of the user who performed the action. |
|
|
Specify the page number for paginated results. |
|
|
Specify the number of rows per page for paginated results. |
|
|
Filter audit records to entries on or after this date. |
|
|
Filter audit records to entries on or before this date. |
|
|
Filter audit records by one or more character type identifiers. |
|
|
Set to true to include workflow-related audit entries. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table/{id}/audit-history-detail
/v4/table/{id}/audit-history-detail
Retrieves detailed audit history entries for a specific table. Use this action to see the specific field-level changes recorded in the audit log.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter by the audit detail identifier. |
|
|
Filter by whether the entry is a header record. |
|
|
Filter by the audit identifier. |
|
|
Filter by the sequence number of the audit entry. |
|
|
Filter by the operation type identifier. |
|
|
Set to true to include associated messages in the result. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table/{id}/copy-warnings
/v4/table/{id}/copy-warnings
Retrieves any copy warnings associated with a specific table. Use this action to identify potential issues before copying the table.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
Specify the template identifier to check for copy warnings. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table/{id}/date-alerts
/v4/table/{id}/date-alerts
Retrieves date-related alerts for a specific table. Use this action to view notifications about upcoming or past due dates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table/{id}/date-math
/v4/table/{id}/date-math
Retrieves date math information for a specific table. Use this action to calculate date differences or adjustments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table/{id}/draft-templates
/v4/table/{id}/draft-templates
Retrieves draft templates associated with a specific table. Use this action to list available templates for creating drafts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /v4/table/{id}/execute-document-workflow-action/{actionID}
/v4/table/{id}/execute-document-workflow-action/{actionID}
Executes a document workflow action on a specific table. Use this action to trigger a predefined document workflow step.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the template to use for the document workflow action. |
PUT /v4/table/{id}/execute-signature-workflow-action/{actionID}
/v4/table/{id}/execute-signature-workflow-action/{actionID}
Executes a signature workflow action on a specific table. Use this action to trigger a predefined signature workflow step.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the document to be signed. |
|
|
Array of email addresses for signatories. |
|
|
Array of email addresses to be copied on the signature request. |
|
|
Whether to enforce the signing order. |
|
|
Number of days after which the signature request expires. |
|
|
Number of days before expiration to send a warning. |
PUT /v4/table/{id}/execute-workflow-action/{actionID}
/v4/table/{id}/execute-workflow-action/{actionID}
Executes a general workflow action on a specific table. Use this action to trigger a predefined workflow step.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The identifier of the workflow action to execute. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/table/{id}/get-lov-friendly-string/{tagLabel}
/v4/table/{id}/get-lov-friendly-string/{tagLabel}
Retrieve the friendly display string for a specified list of values (LOV) tag within a table. Use this to obtain a human-readable label for a tag value.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The tag label to filter the template by. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/table/{id}/switch-template
/v4/table/{id}/switch-template
Switch the template applied to a table to a different one. Use this to change the layout or structure of a table's data presentation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
POST /v4/table/{id}/switch-template-check
/v4/table/{id}/switch-template-check
Check whether a table's template can be switched without errors. Use this to validate a template switch before executing it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the amount record. |
|
|
The revision number of the amount record. |
|
|
The title or name of the amount. |
|
|
The identifier of the user who created the amount. |
|
|
The date and time when the amount was created. |
|
|
The identifier of the user who last updated the amount. |
|
|
The date and time of the last update to the amount. |
|
|
The identifier of the user who last updated the status. |
|
|
The date and time when the status was last updated. |
|
|
The number of parent relationships associated with the amount. |
|
|
The identifier of the character type to switch to. |
|
|
Whether to copy relationships from the old template. |
|
|
The identifier of the new template to apply. |
|
|
Whether to copy parties from the old template. |
GET /v4/table/{id}/validation-errors
/v4/table/{id}/validation-errors
Retrieve a list of validation errors for a table. Use this to identify and resolve data issues within the table.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
User (4)
POST /v4/user/data-default
/v4/user/data-default
Set the default data set for the current user. Use this to define which data set is automatically selected when the user logs in.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
DELETE /v4/user/data-default/{setGuid}
/v4/user/data-default/{setGuid}
Remove a specific default data set assignment for the current user. Use this to clear a previously set default.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The GUID of the default data set to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/user/{id}/data-default
/v4/user/{id}/data-default
Retrieve the default data set for a specified user. Use this to see which data set is automatically selected for that user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v4/user/{id}/data-default
/v4/user/{id}/data-default
Set the default data set for a specified user. Use this to assign a data set that will be automatically selected for that user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the amount template. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier for the default data set. |
|
|
An array of record identifiers to include in the default data. |
|
|
The identifier of the characteristic type for the set. |
|
|
A label for the default data set. |
|
|
The identifier of the related characteristic type. |
|
|
The identifier of the related child characteristic type. |
|
|
Indicates whether to copy titles into the default data. |
Worksheet (2)
GET /v4/worksheet
/v4/worksheet
Retrieve a list of all available worksheets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /v4/worksheet/{worksheetId}
/v4/worksheet/{worksheetId}
Retrieve details for a specific worksheet.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the worksheet to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |