Create a Contract
Description
This endpoint is used to create a contract.
Please note that the values for jobEntityId, orderEntityId, and containerEntityIds must be valid entity IDs that exist in the system and within the job or order, as relevant.
The assignmentType and services values will be sourced from controlled vocabulary endpoints Get Assignment Types and Get Work Order Services, respectively.
Within the characters array, you can provide one or more characterName values for voice talent contracts. The character names can be sourced from the Get Characters endpoint.
The dubbingStudioContactEntityId is optional, but if you wish to enforce a second signature on the contract from the dubbing studio, then you can provide the entity ID of a user that exists in the system. You can source users using the Search User endpoint. It is recommended you use the dubbing studio manager that was associated with the order via the claim order process using the Claim Order endpoint.
The counterSignatoryContactEntityId is optional, but if you need to add a counter signatory, then you can provide the entity ID of a valid counter signatory contact. You can retrieve the list of available counter signatories for an order using the Get Counter Signatories endpoint, which returns contacts based on the job's source and the territory associated with the order.
Within the talent object, the talentContactEntityId must be a valid entity ID for a contact in the system, and the talentSignerType must be one of the accepted enum values.
You can create a contact using the Create Contact endpoint. You can find a contact using Search Contact.
Endpoint
Request parameters
Responses
Examples
Dub Studio Contract
In the case of having only the minimum required fields for a dub studio contract, then the request body would look like the following.
It is recommended the entity id passed in the dubbingStudioContactEntityId field is the dubbing studio manager that was associated with the order via the claim order process using the Claim Order endpoint.
If the dub studio contract requires a counter signatory signature, include the counterSignatoryContactEntityId field:
Minimum Required Fields for Non-Voice Talent Contracts Without Services
In the case of having only the minimum required fields, which would be a non-voice talent contract for only an adult contributor and an assignmentType of artist label or lyric sheets, then the request body would look like the following. For these types, services are not required, so the request body would look like the following.
To add a dub studio manager signature, include the optional dubbingStudioContactEntityId field. To add a counter signatory signature, include the optional counterSignatoryContactEntityId field.
Minimum Required Fields for Non-Voice Talent Contracts With Services
In the case of having only the minimum required fields, which would be a non-voice talent contract for only an adult contributor, then the request body would look like the following.
Please note that replacing the assignmentType of translator with director, adapter, and are also all valid values for the contracts, too. Services are required for these types.
To add a dub studio manager signature, include the optional dubbingStudioContactEntityId field. To add a counter signatory signature, include the optional counterSignatoryContactEntityId field.
Minimum Required Fields for Voice Talent Contracts
In the case of having only the minimum required fields for a voice talent contract for only an adult contributor, then the characters section becomes required. Additionally, services are also required for voice talent contracts.
The character information can be sourced from the Get Characters endpoint.
To add a dub studio manager signature, include the optional dubbingStudioContactEntityId field. To add a counter signatory signature, include the optional counterSignatoryContactEntityId field. The following example demonstrates using a counter signatory:
Maximum Required Fields
In the case of having all required fields filled out, which would be a voice talent contract with multiple containers, a minor contributor and an agent, a dub studio manager, and a counter signatory, then the request body would look like this:
Related Documentation
Get Assignment Types: Retrieve valid assignment types.
Get Characters: Retrieve characters for voice talent contracts.
Get Counter Signatories: Retrieve counter signatory contacts for an order.
Claim Order: Claim an order for the dub studio manager on the contract.
Search Users: Search users to use as the dubbing studio contact.
Create Contact: Create a contact to use as talent.
Search Contacts: Search contacts to use as a talent.
Get Work Order Services: Retrieve valid work order services.
Upload Contract: Upload a completed contract.
Void Contract: Void an existing contract.
API Reference: See all available endpoints and details.