> For the complete documentation index, see [llms.txt](https://api-docs.rightsline.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.rightsline.com/entities.md). # Entities - [Char types](https://api-docs.rightsline.com/entities/char-types.md): Each char type in Rightsline relates to a single numeric identifier, often referred to as a Char Type ID. These char type identifiers are used when describing relationships between entities. - [The entity object](https://api-docs.rightsline.com/entities/the-entity-object.md): All Rightsline entities share a common structure. This structure is used to enforce consistency across different entity types. - [Amount](https://api-docs.rightsline.com/entities/amount.md) - [Create an amount](https://api-docs.rightsline.com/entities/amount/amount-create.md) - [Retrieve an amount](https://api-docs.rightsline.com/entities/amount/amount-retrieve.md) - [Update an amount](https://api-docs.rightsline.com/entities/amount/amount-update.md) - [Delete an amount](https://api-docs.rightsline.com/entities/amount/amount-delete.md) - [Retrieve amount statuses](https://api-docs.rightsline.com/entities/amount/retrieve-amount-statuses.md) - [Retrieve amount workflow processes](https://api-docs.rightsline.com/entities/amount/retrieve-amount-processes.md) - [Retrieve amount draft templates](https://api-docs.rightsline.com/entities/amount/retrieve-amount-draft-templates.md) - [Retrieve amount audit history](https://api-docs.rightsline.com/entities/amount/audit-history.md): Retrieve the audit history for an amount record. - [Switch amount template](https://api-docs.rightsline.com/entities/amount/switch-amount-template.md): Switches the amount record to a new template - [Retrieve amount validation errors](https://api-docs.rightsline.com/entities/amount/validation-errors.md) - [Catalog item](https://api-docs.rightsline.com/entities/catalog-item.md) - [Create a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-create.md) - [Retrieve a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-retrieve.md) - [Update a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-update.md) - [Delete a catalog item](https://api-docs.rightsline.com/entities/catalog-item/catalogitem-delete.md) - [Retrieve catalog item template list](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-template-list.md) - [Retrieve catalog item statuses](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-statuses.md) - [Retrieve catalog item workflow processes](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-processes.md) - [Retrieve catalog item draft templates](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-draft-templates.md) - [Retrieve catalog item key art URL](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-key-art-url.md): Used to retrieve key art for a catalog item. - [Upload/update catalog item key art](https://api-docs.rightsline.com/entities/catalog-item/update-catalog-item-key-art.md): Upload/update the key art for a catalog item. - [Delete catalog item key art](https://api-docs.rightsline.com/entities/catalog-item/delete-catalog-item-key-art.md): Delete the key art for a catalog item. - [Retrieve catalog item audit history](https://api-docs.rightsline.com/entities/catalog-item/audit-history.md): Retrieve the audit history for a catalog item record. - [Switch catalog item template](https://api-docs.rightsline.com/entities/catalog-item/switch-catalog-item-template.md): Switches the catalog item record to a new template - [Retrieve catalog item validation errors](https://api-docs.rightsline.com/entities/catalog-item/validation-errors.md) - [Retrieve all rights in catalog hierarchy](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-rights-in-hierarchy.md) - [Catalog item delete check](https://api-docs.rightsline.com/entities/catalog-item/delete-check.md) - [Retrieve catalog item worksheets](https://api-docs.rightsline.com/entities/catalog-item/retrieve-catalog-item-worksheets.md) - [Overwrite catalog item parties](https://api-docs.rightsline.com/entities/catalog-item/overwrite-catalog-item-parties.md) - [Contact](https://api-docs.rightsline.com/entities/contact.md) - [Create a contact](https://api-docs.rightsline.com/entities/contact/contact-create.md) - [Retrieve a contact](https://api-docs.rightsline.com/entities/contact/contact-retrieve.md) - [Update a contact](https://api-docs.rightsline.com/entities/contact/contact-update.md) - [Delete a contact](https://api-docs.rightsline.com/entities/contact/contact-delete.md) - [Retrieve contact statuses](https://api-docs.rightsline.com/entities/contact/retrieve-contact-statuses.md) - [Retrieve contact workflow processes](https://api-docs.rightsline.com/entities/contact/retrieve-contact-processes.md) - [Retrieve contact draft templates](https://api-docs.rightsline.com/entities/contact/retrieve-contact-draft-templates.md) - [Retrieve contact audit history](https://api-docs.rightsline.com/entities/contact/audit-history.md): Retrieve the audit history for a contact record. - [Switch contact template](https://api-docs.rightsline.com/entities/contact/switch-contact-template.md): Switches the contact record to a new template - [Contact delete check](https://api-docs.rightsline.com/entities/contact/delete-check.md) - [Retrieve contact validation errors](https://api-docs.rightsline.com/entities/contact/validation-errors.md) - [Deal](https://api-docs.rightsline.com/entities/deal.md) - [Create a deal](https://api-docs.rightsline.com/entities/deal/deal-create.md) - [Retrieve a deal](https://api-docs.rightsline.com/entities/deal/deal-retrieve.md) - [Update a deal](https://api-docs.rightsline.com/entities/deal/deal-update.md) - [Delete a deal](https://api-docs.rightsline.com/entities/deal/deal-delete.md) - [Retrieve deal statuses](https://api-docs.rightsline.com/entities/deal/retrieve-deal-statuses.md) - [Retrieve deal workflow processes](https://api-docs.rightsline.com/entities/deal/retrieve-deal-processes.md) - [Retrieve deal draft templates](https://api-docs.rightsline.com/entities/deal/retrieve-deal-draft-templates.md) - [Retrieve deal audit history](https://api-docs.rightsline.com/entities/deal/audit-history.md): Retrieve the audit history for a deal record. - [Switch deal template](https://api-docs.rightsline.com/entities/deal/switch-deal-template.md): Switches the deal record to a new template - [Retrieve deal validation errors](https://api-docs.rightsline.com/entities/deal/validation-errors.md) - [Retrieve deal conflicts](https://api-docs.rightsline.com/entities/deal/conflicts.md) - [Override deal conflict](https://api-docs.rightsline.com/entities/deal/override-conflict.md) - [Overwrite deal parties](https://api-docs.rightsline.com/entities/deal/overwrite-deal-parties.md) - [File](https://api-docs.rightsline.com/entities/file.md) - [Create a file](https://api-docs.rightsline.com/entities/file/file-create.md) - [Retrieve a file](https://api-docs.rightsline.com/entities/file/file-retrieve.md) - [Retrieve File Version](https://api-docs.rightsline.com/entities/file/file-version-retrieve.md) - [Retrieve File Revisions](https://api-docs.rightsline.com/entities/file/file-revisions-retrieve.md): Retrieve a list of the existing revisions of a specific file. - [Retrieve file data](https://api-docs.rightsline.com/entities/file/file-data-retrieve.md) - [Retrieve File Version URL](https://api-docs.rightsline.com/entities/file/file-version-url-retrieve.md) - [Retrieve File Version Data](https://api-docs.rightsline.com/entities/file/file-version-data-retrieve.md) - [Delete a file](https://api-docs.rightsline.com/entities/file/file-delete.md) - [Retrieve file statuses](https://api-docs.rightsline.com/entities/file/retrieve-file-statuses.md) - [Retrieve file workflow processes](https://api-docs.rightsline.com/entities/file/retrieve-file-processes.md) - [Retrieve file draft templates](https://api-docs.rightsline.com/entities/file/retrieve-file-draft-templates.md) - [Retrieve file validation errors](https://api-docs.rightsline.com/entities/file/validation-errors.md) - [Grant Access To File](https://api-docs.rightsline.com/entities/file/grant-access-to.md): This will grant a user or users access to the file in Partner Portal. - [Revoke Access From File](https://api-docs.rightsline.com/entities/file/revoke-access-from.md): This will revoke a user or users access to the file in Partner Portal. - [Financial document](https://api-docs.rightsline.com/entities/financial-document.md) - [Create a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-create.md) - [Retrieve a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-retrieve.md) - [Update a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-update.md) - [Delete a financial document](https://api-docs.rightsline.com/entities/financial-document/financial-document-delete.md) - [Retrieve financial document statuses](https://api-docs.rightsline.com/entities/financial-document/retrieve-financial-document-statuses.md) - [Retrieve financial document workflow processes](https://api-docs.rightsline.com/entities/financial-document/retrieve-financial-document-processes.md) - [Retrieve financial document draft templates](https://api-docs.rightsline.com/entities/financial-document/retrieve-financial-document-draft-templates.md) - [Retrieve financial document audit history](https://api-docs.rightsline.com/entities/financial-document/audit-history.md): Retrieve the audit history for a financial document record. - [Switch financial document template](https://api-docs.rightsline.com/entities/financial-document/switch-financial-document-template.md): Switches the financial document record to a new template - [Retrieve financial document validation errors](https://api-docs.rightsline.com/entities/financial-document/validation-errors.md) - [Overwrite financial document parties](https://api-docs.rightsline.com/entities/financial-document/overwrite-financial-document-parties.md) - [Inventory](https://api-docs.rightsline.com/entities/inventory.md) - [Create an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-create.md) - [Retrieve an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-retrieve.md) - [Update an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-update-1.md) - [Delete an inventory item](https://api-docs.rightsline.com/entities/inventory/inventory-delete.md) - [Retrieve inventory statuses](https://api-docs.rightsline.com/entities/inventory/retrieve-inventory-statuses.md) - [Retrieve inventory workflow processes](https://api-docs.rightsline.com/entities/inventory/retrieve-inventory-processes.md) - [Retrieve inventory draft templates](https://api-docs.rightsline.com/entities/inventory/retrieve-inventory-draft-templates.md) - [Retrieve an inventory key art URL](https://api-docs.rightsline.com/entities/inventory/retrieve-an-inventory-key-art-url.md): Used to retrieve key art for an inventory item. - [Update an inventory key art](https://api-docs.rightsline.com/entities/inventory/update-an-inventory-key-art.md) - [Delete an inventory key art](https://api-docs.rightsline.com/entities/inventory/delete-an-inventory-key-art.md): Delete the key art for an inventory item. - [Retrieve inventory audit history](https://api-docs.rightsline.com/entities/inventory/audit-history.md): Retrieve the audit history for an inventory record. - [Switch inventory template](https://api-docs.rightsline.com/entities/inventory/switch-inventory-template.md): Switches the inventory record to a new template - [Retrieve inventory validation errors](https://api-docs.rightsline.com/entities/inventory/validation-errors.md) - [Overwrite inventory parties](https://api-docs.rightsline.com/entities/inventory/overwrite-inventory-parties.md) - [Project](https://api-docs.rightsline.com/entities/project.md) - [Create a project](https://api-docs.rightsline.com/entities/project/project-create.md) - [Retrieve a project](https://api-docs.rightsline.com/entities/project/project-retrieve.md) - [Update a project](https://api-docs.rightsline.com/entities/project/project-update.md) - [Delete a project](https://api-docs.rightsline.com/entities/project/project-delete.md) - [Retrieve project statuses](https://api-docs.rightsline.com/entities/project/retrieve-project-statuses.md) - [Retrieve project workflow processes](https://api-docs.rightsline.com/entities/project/retrieve-project-processes.md) - [Retrieve project draft templates](https://api-docs.rightsline.com/entities/project/retrieve-project-draft-templates.md) - [Retrieve project audit history](https://api-docs.rightsline.com/entities/project/audit-history.md): Retrieve the audit history for an inventory record. - [Switch project template](https://api-docs.rightsline.com/entities/project/switch-project-template.md): Switches the inventory record to a new template - [Retrieve project validation errors](https://api-docs.rightsline.com/entities/project/validation-errors.md) - [Overwrite project parties](https://api-docs.rightsline.com/entities/project/overwrite-deal-parties.md) - [Job](https://api-docs.rightsline.com/entities/job.md) - [Create a job](https://api-docs.rightsline.com/entities/job/job-create.md) - [Retrieve a job](https://api-docs.rightsline.com/entities/job/job-retrieve.md) - [Update a job](https://api-docs.rightsline.com/entities/job/job-update.md) - [Delete a job](https://api-docs.rightsline.com/entities/job/job-delete.md) - [Retrieve job statuses](https://api-docs.rightsline.com/entities/job/retrieve-job-statuses.md) - [Retrieve job workflow processes](https://api-docs.rightsline.com/entities/job/retrieve-job-processes.md) - [Retrieve job draft templates](https://api-docs.rightsline.com/entities/job/retrieve-job-draft-templates.md) - [Retrieve job audit history](https://api-docs.rightsline.com/entities/job/audit-history.md): Retrieve the audit history for a job record. - [Switch job template](https://api-docs.rightsline.com/entities/job/switch-job-template.md): Switches the job record to a new template - [Retrieve job validation errors](https://api-docs.rightsline.com/entities/job/validation-errors.md) - [Overwrite job parties](https://api-docs.rightsline.com/entities/job/overwrite-job-parties.md) - [Right](https://api-docs.rightsline.com/entities/right.md) - [Create a right](https://api-docs.rightsline.com/entities/right/right-create.md) - [Retrieve a right](https://api-docs.rightsline.com/entities/right/right-retrieve.md) - [Update a right](https://api-docs.rightsline.com/entities/right/right-update.md) - [Delete a right](https://api-docs.rightsline.com/entities/right/right-delete.md) - [Retrieve right statuses](https://api-docs.rightsline.com/entities/right/retrieve-right-statuses.md) - [Retrieve right workflow processes](https://api-docs.rightsline.com/entities/right/retrieve-right-processes.md) - [Retrieve right draft templates](https://api-docs.rightsline.com/entities/right/retrieve-right-draft-templates.md) - [Retrieve relative rights profiles](https://api-docs.rightsline.com/entities/right/retrieve-relative-rights-profiles.md) - [Execute relative rights profile](https://api-docs.rightsline.com/entities/right/execute-relative-rights-profile.md) - [Retrieve right audit history](https://api-docs.rightsline.com/entities/right/audit-history.md): Retrieve the audit history for a right record. - [Switch right template](https://api-docs.rightsline.com/entities/right/switch-right-template.md): Switches the right record to a new template - [Retrieve right validation errors](https://api-docs.rightsline.com/entities/right/validation-errors.md) - [Table](https://api-docs.rightsline.com/entities/table.md) - [Create a table row](https://api-docs.rightsline.com/entities/table/tablerow-create.md) - [Retrieve a table row](https://api-docs.rightsline.com/entities/table/tablerow-retrieve.md) - [Update a table row](https://api-docs.rightsline.com/entities/table/tablerow-update.md) - [Delete a table row](https://api-docs.rightsline.com/entities/table/tablerow-delete.md) - [Retrieve table statuses](https://api-docs.rightsline.com/entities/table/retrieve-table-statuses.md) - [Retrieve table workflow processes](https://api-docs.rightsline.com/entities/table/retrieve-table-processes.md) - [Retrieve table draft templates](https://api-docs.rightsline.com/entities/table/retrieve-table-draft-templates.md) - [Retrieve table audit history](https://api-docs.rightsline.com/entities/table/audit-history.md): Retrieve the audit history for a table record. - [Switch table template](https://api-docs.rightsline.com/entities/table/switch-table-template.md): Switches the right record to a new template - [Retrieve table validation errors](https://api-docs.rightsline.com/entities/table/validation-errors.md) - [Contract Scope](https://api-docs.rightsline.com/entities/contract-scope.md) - [Create a contract scope](https://api-docs.rightsline.com/entities/contract-scope/create-a-contract-scope.md) - [Retrieve a contract scope](https://api-docs.rightsline.com/entities/contract-scope/retrieve-a-contract-scope.md) - [Update a contract scope](https://api-docs.rightsline.com/entities/contract-scope/update-a-contract-scope.md) - [Delete a contract scope](https://api-docs.rightsline.com/entities/contract-scope/delete-a-contract-scope.md) - [Search contract scopes](https://api-docs.rightsline.com/entities/contract-scope/search-contract-scopes.md) - [Search deleted contract scopes](https://api-docs.rightsline.com/entities/contract-scope/search-deleted-contract-scopes.md) - [Retrieve contract scope templates](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-templates.md) - [Retrieve a contract scope template](https://api-docs.rightsline.com/entities/contract-scope/retrieve-a-contract-scope-template.md) - [Retrieve contract scope statuses](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-statuses.md) - [Retrieve contract scope fields](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-fields.md) - [Retrieve contract scope workflow processes](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-workflow-processes.md) - [Execute a workflow action](https://api-docs.rightsline.com/entities/contract-scope/execute-a-workflow-action.md) - [Retrieve contract scope draft templates](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-draft-templates.md) - [Retrieve contract scope audit history](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-audit-history.md) - [Retrieve contract scope audit history detail](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-audit-history-detail.md) - [Retrieve contract scope validation errors](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-validation-errors.md) - [Retrieve copy warnings](https://api-docs.rightsline.com/entities/contract-scope/retrieve-copy-warnings.md) - [Switch contract scope template](https://api-docs.rightsline.com/entities/contract-scope/switch-contract-scope-template.md) - [Check contract scope template switch](https://api-docs.rightsline.com/entities/contract-scope/check-contract-scope-template-switch.md) - [Retrieve contract scope date alerts](https://api-docs.rightsline.com/entities/contract-scope/retrieve-contract-scope-date-alerts.md) - [Recipient Group](https://api-docs.rightsline.com/entities/recipient-group.md) - [Create a Recipient Group](https://api-docs.rightsline.com/entities/recipient-group/create-a-recipient-group.md) - [Retrieve a Recipient Group](https://api-docs.rightsline.com/entities/recipient-group/retrieve-a-recipient-group.md) - [Update a Recipient Group](https://api-docs.rightsline.com/entities/recipient-group/update-a-recipient-group.md) - [Delete a Recipient Group](https://api-docs.rightsline.com/entities/recipient-group/delete-a-recipient-group.md) - [Search Recipient Groups](https://api-docs.rightsline.com/entities/recipient-group/search-recipient-groups.md) - [Search Deleted Recipient Groups](https://api-docs.rightsline.com/entities/recipient-group/search-deleted-recipient-groups.md) - [Retrieve Recipient Group Templates](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-templates.md) - [Retrieve a Recipient Group Template](https://api-docs.rightsline.com/entities/recipient-group/retrieve-a-recipient-group-template.md) - [Retrieve Recipient Group Statuses](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-statuses.md) - [Retrieve Recipient Group Fields](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-fields.md) - [Retrieve Recipient Group Workflow Processes](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-workflow-processes.md) - [Execute a Workflow Action](https://api-docs.rightsline.com/entities/recipient-group/execute-a-workflow-action.md) - [Retrieve Recipient Group Draft Templates](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-draft-templates.md) - [Retrieve Recipient Group Audit History](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-audit-history.md) - [Retrieve Recipient Group Audit History Detail](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-audit-history-detail.md) - [Retrieve Recipient Group Validation Errors](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-validation-errors.md) - [Retrieve Copy Warnings](https://api-docs.rightsline.com/entities/recipient-group/retrieve-copy-warnings.md) - [Switch Recipient Group Template](https://api-docs.rightsline.com/entities/recipient-group/switch-recipient-group-template.md) - [Check Recipient Group Template Switch](https://api-docs.rightsline.com/entities/recipient-group/check-recipient-group-template-switch.md) - [Retrieve Recipient Group Date Alerts](https://api-docs.rightsline.com/entities/recipient-group/retrieve-recipient-group-date-alerts.md)