See Getting Started as a Developer for REST API for information on how to get started. 

openapi: "3.0.0" info: version: "2" title: Conga Contracts REST API description: "Conga Contracts REST API" servers: - url: https://app1.congacontracts.com/Contracts/rest/v2 - url: https://app1.novatuscontracts.com/Contracts/rest/v2 tags: - name: "Clause" - name: "Company" - name: "CompanyPerson" - name: "Contract" - name: "CreationTemplate" - name: "Describe" - name: "Document" - name: "DynamicForm" - name: "Event" - name: "ListAdmin" - name: "Payment" - name: "Person" - name: "Project" - name: "Request" - name: "Session" - name: "User" paths: /clause: get: tags: - "Clause" summary: Query clauses operationId: queryClauses parameters: - name: q in: query description: The NQL query to find clauses required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of clauses content: application/json: schema: $ref: "#/components/schemas/ClauseQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Clause" summary: Create a clause operationId: createClause requestBody: content: application/json: schema: $ref: "#/components/schemas/Clause" responses: 200: description: The ID of the created clause content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Clause" summary: Update a clause operationId: updateClause requestBody: content: application/json: schema: $ref: "#/components/schemas/Clause" responses: 200: description: The ID of the updated clause content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /clause/{id}: get: tags: - "Clause" summary: Get a clause by ID operationId: getClause parameters: - name: id in: path description: The clause ID to get required: true schema: type: string responses: 200: description: A clause content: application/json: schema: $ref: "#/components/schemas/Clause" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /clause/search: get: tags: - "Clause" summary: Search clauses operationId: searchClauses parameters: - name: q in: query description: The text to search for in clauses required: true schema: type: string responses: 200: description: A paged array of clauses content: application/json: schema: $ref: "#/components/schemas/ClauseQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company: put: tags: - "Company" summary: Update a company operationId: updateCompany requestBody: content: application/json: schema: $ref: "#/components/schemas/Company" responses: 200: description: The ID of the updated company content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Company" summary: Create a company operationId: createCompany requestBody: content: application/json: schema: $ref: "#/components/schemas/Company" responses: 200: description: The ID of the updated company content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" get: tags: - "Company" summary: Query companies operationId: queryCompanies parameters: - name: q in: query description: The NQL query to find companies required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of companies content: application/json: schema: $ref: "#/components/schemas/CompanyQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}: get: tags: - "Company" summary: Get a company by ID operationId: getCompany parameters: - name: id in: path description: The company ID to get required: true schema: type: string responses: 200: description: A company content: application/json: schema: $ref: "#/components/schemas/Company" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "Company" summary: Modify a company operationId: patchCompany parameters: - name: id in: path description: The company ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object example: name: New Company Name dynamics.do_e8a5de20bb374fd192dfc329ddf93cdb: Dynamic Field Value responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}/relationships: get: tags: - "Company" summary: Get company relationships by company ID operationId: getCompanyRelationships parameters: - name: id in: path description: The company ID to get relationships required: true schema: type: string responses: 200: description: An array of company relationships content: application/json: schema: type: array items: $ref: "#/components/schemas/CompanyRelationship" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Company" summary: Save company relationships operationId: setCompanyRelationships parameters: - name: id in: path description: The company ID to set relationships required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/CompanyRelationship" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}/locations: get: tags: - "Company" summary: Get company locations by company ID operationId: getCompanyLocations parameters: - name: id in: path description: The company ID to get locations required: true schema: type: string responses: 200: description: An array of company locations content: application/json: schema: type: array items: $ref: "#/components/schemas/Location" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Company" summary: Save company locations operationId: setCompanyLocations parameters: - name: id in: path description: The company ID to set locations required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/Location" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}/additionalnames: get: tags: - "Company" summary: Get company additional names by company ID operationId: getCompanyAdditionalNames parameters: - name: id in: path description: The company ID to get additional names required: true schema: type: string responses: 200: description: An array of company additional names content: application/json: schema: type: array items: $ref: "#/components/schemas/CompanyAdditionalName" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Company" summary: Save company additional names operationId: setCompanyAdditionalNames parameters: - name: id in: path description: The company ID to set additional names required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/CompanyAdditionalName" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}/additionalforms: get: tags: - "Company" summary: Get additional dynamic forms for a company operationId: getCompanyDynamicForms parameters: - name: id in: path description: The company ID to get additional forms required: true schema: type: string responses: 200: description: The additional forms on the company content: application/json: schema: type: array items: $ref: "#/components/schemas/DynamicForm" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/bulk: post: tags: - "Company" summary: Bulk creation of a company operationId: bulkCompany requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/BulkCreateRequestCompany" responses: 200: description: The results of the bulk operation content: application/json: schema: type: array items: $ref: "#/components/schemas/BulkCreateResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}/relationship: post: tags: - "Company" summary: Add a single relationship to a company operationId: addSingleRelationshipCompany parameters: - name: id in: path description: The company ID to add the relationship required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CompanyRelationship" responses: 200: description: The ID of the relationship content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}/location: post: tags: - "Company" summary: Add a single location to a company operationId: addSingleLocationCompany parameters: - name: id in: path description: The company ID to add the location required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Location" responses: 200: description: The ID of the location content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/{id}/additionalname: post: tags: - "Company" summary: Add a single additional name to a company operationId: addSingleAdditionalNameCompany parameters: - name: id in: path description: The company ID to add the additional name required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CompanyAdditionalName" responses: 200: description: The ID of the additional name content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/relationship/{id}: patch: tags: - "Company" summary: Modify a company relationship operationId: patchCompanyRelationship parameters: - name: id in: path description: The relationship ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/location/{id}: patch: tags: - "Company" summary: Modify a company location operationId: patchCompanyLocation parameters: - name: id in: path description: The location ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /company/additionalname/{id}: patch: tags: - "Company" summary: Modify a company additional name operationId: patchCompanyAdditionalName parameters: - name: id in: path description: The additional name ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /companyperson: put: tags: - "CompanyPerson" summary: Update a company person operationId: updateCompanyPerson requestBody: content: application/json: schema: $ref: "#/components/schemas/CompanyPerson" responses: 200: description: The ID of the updated companyperson content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "CompanyPerson" summary: Create a company person operationId: createCompanyPerson requestBody: content: application/json: schema: $ref: "#/components/schemas/CompanyPerson" responses: 200: description: The ID of the created company person content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" get: tags: - "CompanyPerson" summary: Query company persons operationId: queryCompanyPersons parameters: - name: q in: query description: The NQL query to find company persons required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of company persons content: application/json: schema: $ref: "#/components/schemas/CompanyPersonQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /companyperson/{id}: get: tags: - "CompanyPerson" summary: Get a company person by ID operationId: getCompanyPerson parameters: - name: id in: path description: The company person ID to get required: true schema: type: string responses: 200: description: A company person content: application/json: schema: $ref: "#/components/schemas/CompanyPerson" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "CompanyPerson" summary: Modify a company person operationId: patchCompanyPerson parameters: - name: id in: path description: The company person ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract: put: tags: - "Contract" summary: Update a contract operationId: updateContract requestBody: content: application/json: schema: $ref: "#/components/schemas/Contract" responses: 200: description: The ID of the updated contract content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Contract" summary: Create a contract operationId: createContract requestBody: content: application/json: schema: $ref: "#/components/schemas/Contract" responses: 200: description: The ID of the created contract content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" get: tags: - "Contract" summary: Query contracts operationId: queryContracts parameters: - name: q in: query description: The NQL query to find contracts required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of contract content: application/json: schema: $ref: "#/components/schemas/ContractQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}: get: tags: - "Contract" summary: Get contract by ID operationId: getContract parameters: - name: id in: path description: The contract ID to get required: true schema: type: string responses: 200: description: A contract content: application/json: schema: $ref: "#/components/schemas/Contract" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "Contract" summary: Modify a contract operationId: patchContract parameters: - name: id in: path description: The contract ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object example: description: New Contract Description dynamics.do_e8a5de20bb374fd192dfc329ddf93cdb: Dynamic Field Value responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}/additionalparty: get: tags: - "Contract" summary: Get contract additional parties by contract ID operationId: getContractAdditionalParties parameters: - name: id in: path description: The contract ID to get additional parties required: true schema: type: string responses: 200: description: An array of contract additional parties content: application/json: schema: type: array items: $ref: "#/components/schemas/AdditionalParty" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Contract" summary: Save contract additional parties operationId: setContractAdditionalParties parameters: - name: id in: path description: The contract ID to set additional parties required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/AdditionalParty" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Contract" summary: Add a single additional party to a contract operationId: addSingleAdditionalPartyContract parameters: - name: id in: path description: The contract ID to add the additional party required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/AdditionalParty" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}/responsibilities: get: tags: - "Contract" summary: Get contract responsibilities by contract ID operationId: getContractResponsibilities parameters: - name: id in: path description: The contract ID to get responsibilities required: true schema: type: string responses: 200: description: An array of contract responsibilities content: application/json: schema: type: array items: $ref: "#/components/schemas/ContractResponsibility" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Contract" summary: Save contract responsibilities operationId: setContractResponsibilities parameters: - name: id in: path description: The contract ID to set responsibilities required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/ContractResponsibility" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}/locations: get: tags: - "Contract" summary: Get contract locations by contract ID operationId: getContractLocations parameters: - name: id in: path description: The contract ID to get locations required: true schema: type: string responses: 200: description: An array of contract locations content: application/json: schema: type: array items: $ref: "#/components/schemas/ContractLocation" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Contract" summary: Save contract locations operationId: setContractLocations parameters: - name: id in: path description: The contract ID to set locations required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/ContractLocation" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}/additionalforms: get: tags: - "Contract" summary: Get additional dynamic forms for a contract operationId: getContractDynamicForms parameters: - name: id in: path description: The contract ID to get additional forms required: true schema: type: string responses: 200: description: The additional forms on the contract content: application/json: schema: type: array items: $ref: "#/components/schemas/DynamicForm" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}/assignContract: get: tags: - "Contract" summary: Assign a contract to a different company operationId: assignContract parameters: - name: id in: path description: The contract id to reassign required: true schema: type: string responses: 200: description: the contract ID content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/bulk: post: tags: - "Contract" summary: Bulk creation of contract operationId: bulkContract requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/BulkCreateRequestContract" responses: 200: description: The results of the bulk operation content: application/json: schema: type: array items: $ref: "#/components/schemas/BulkCreateResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}/location: post: tags: - "Contract" summary: Add a single contract location to a contract operationId: addSingleLocationContract parameters: - name: id in: path description: The contract ID to add the location required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ContractLocation" responses: 200: description: The ID of the contract location content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{id}/responsibility: post: tags: - "Contract" summary: Add a single contract responsibility to a contract operationId: addSingleResponsibilityContract parameters: - name: id in: path description: The contract ID to add the responsibility required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ContractResponsibility" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/location/{id}: patch: tags: - "Contract" summary: Modify a contract location operationId: patchContractLocation parameters: - name: id in: path description: The contract location ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /contract/{contractid}/additionalparty/{companyid}: patch: tags: - "Contract" summary: Modify a contract additional party operationId: patchContractAdditionalParty parameters: - name: contractid in: path description: The contract ID to modify required: true schema: type: string - name: companyid in: path description: The company ID of the additional party required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /creationtemplate/runsimpletemplate/{contractId}/{templateId}: post: tags: - "CreationTemplate" summary: Run a creation template operationId: runSimpleTemplate parameters: - name: contractId in: path description: The contract id to run the creation template on required: true schema: type: string - name: templateId in: path description: The creation template id to run required: true schema: type: string responses: 200: description: The document id of the created document content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /describe/company: get: tags: - "Describe" summary: Describe the Company object operationId: describeCompany responses: 200: description: The description of the Company object content: application/json: schema: $ref: "#/components/schemas/ApiObjectMetadata" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /describe/contract: get: tags: - "Describe" summary: Describe the Contract object operationId: describeContract responses: 200: description: The description of the Contract object content: application/json: schema: $ref: "#/components/schemas/ApiObjectMetadata" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /describe/location: get: tags: - "Describe" summary: Describe the Location object operationId: describeLocation responses: 200: description: The description of the Location object content: application/json: schema: $ref: "#/components/schemas/ApiObjectMetadata" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /describe/dynamicform/{id}: get: tags: - "Describe" summary: Describe a Dynamic Form object operationId: describeDynamicForm parameters: - name: id in: path description: The apiName or configId of the dynamic form required: true schema: type: string responses: 200: description: The description of the Dynamic Form object content: application/json: schema: $ref: "#/components/schemas/ApiObjectMetadata" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /describe/project: get: tags: - "Describe" summary: Describe the Project object operationId: describeProject responses: 200: description: The description of the Project object content: application/json: schema: $ref: "#/components/schemas/ApiObjectMetadata" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /document: put: tags: - "Document" summary: Update a document operationId: updateDocument requestBody: content: application/json: schema: $ref: "#/components/schemas/Document" responses: 200: description: The ID of the updated document content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Document" summary: Create a document operationId: createDocument requestBody: content: multipart/form-data: schema: properties: document: $ref: "#/components/schemas/Document" contents: type: string format: binary responses: 200: description: The ID of the created document content: text/plain: schema: type: string default: description: error content: application/json: schema: $ref: "#/components/schemas/Error" get: tags: - "Document" summary: Query documents operationId: queryDocuments parameters: - name: q in: query description: The NQL query to find documents required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of document content: application/json: schema: $ref: "#/components/schemas/DocumentQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /document/{id}: get: tags: - "Document" summary: Get a document by ID operationId: getDocument parameters: - name: id in: path description: The document ID to get required: true schema: type: string responses: 200: description: A document content: application/json: schema: $ref: "#/components/schemas/Document" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "Document" summary: Modify a document operationId: patchDocument parameters: - name: id in: path description: The document ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /document/{id}/content: get: tags: - "Document" summary: Get the document content operationId: getDocumentContent parameters: - name: id in: path description: The document ID to get required: true schema: type: string responses: 200: description: A document content: application/octet-stream: schema: type: string format: binary default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /dynamicform: put: tags: - "DynamicForm" summary: Update a dynamic form operationId: updateDynamicForm requestBody: content: application/json: schema: $ref: "#/components/schemas/DynamicForm" responses: 200: description: The ID of the updated dynamic form content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "DynamicForm" summary: Create a dynamic form operationId: createDynamicForm requestBody: content: application/json: schema: $ref: "#/components/schemas/DynamicForm" responses: 200: description: The ID of the created dynamic form content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /dynamicform/{config}: get: tags: - "DynamicForm" summary: Query dynamic forms operationId: queryDynamicForms parameters: - name: config in: path description: The dynamic form configuration ID required: true schema: type: string - name: q in: query description: The NQL query to find dynamic forms required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of dynamic form content: application/json: schema: $ref: "#/components/schemas/DynamicFormQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /dynamicform/{config}/{id}: get: tags: - "DynamicForm" summary: Get dynamic form by ID operationId: getDynamicForm parameters: - name: config in: path description: The dynamic form configuration ID required: true schema: type: string - name: id in: path description: The dynamic form ID to get required: true schema: type: string responses: 200: description: A dynamic form content: application/json: schema: $ref: "#/components/schemas/DynamicForm" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "DynamicForm" summary: Modify a dynamic form operationId: patchDynamicForm parameters: - name: id in: path description: The dynamic form ID to modify required: true schema: type: string - name: config in: path description: The dynamic form configuration ID required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object example: dynamics.do_e8a5de20bb374fd192dfc329ddf93cdb: Dynamic Field Value responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /event: get: tags: - "Event" summary: Query events operationId: queryEvents parameters: - name: q in: query description: The NQL query to find events required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of events content: application/json: schema: $ref: "#/components/schemas/EventQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Event" summary: Create an event operationId: createEvent requestBody: content: application/json: schema: $ref: "#/components/schemas/Event" responses: 200: description: The ID of the created event content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Event" summary: Update an event operationId: updateEvent requestBody: content: application/json: schema: $ref: "#/components/schemas/Event" responses: 200: description: The ID of the updated event content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /event/{id}: get: tags: - "Event" summary: Get an event by ID operationId: getEvent parameters: - name: id in: path description: The event ID to get required: true schema: type: string responses: 200: description: A event content: application/json: schema: $ref: "#/components/schemas/Event" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "Event" summary: Modify an event operationId: patchEvent parameters: - name: id in: path description: The event ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /listadmin/{group}/{name}: get: tags: - "ListAdmin" summary: Get a list admin list operationId: getList parameters: - name: group in: path description: the list group required: true schema: type: string - name: name in: path description: the list name required: true schema: type: string responses: 200: description: An array of list items content: application/json: schema: type: array items: $ref: "#/components/schemas/ListComboItem" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "ListAdmin" summary: Write a list admin list operationId: setList parameters: - name: group in: path description: the list group required: true schema: type: string - name: name in: path description: the list name required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/ListComboItem" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "ListAdmin" summary: Add to a list admin list operationId: addToList parameters: - name: group in: path description: the list group required: true schema: type: string - name: name in: path description: the list name required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ListComboItem" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /listadmin/{group}/{name}/{id}: patch: tags: - "ListAdmin" summary: Modify a list admin item operationId: patchListAdminItem parameters: - name: group in: path description: the list group required: true schema: type: string - name: name in: path description: the list name required: true schema: type: string - name: id in: path description: The list admin item ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /payment: get: tags: - "Payment" summary: Query payments operationId: queryPayments parameters: - name: q in: query description: The NQL query to find payments required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of payments content: application/json: schema: $ref: "#/components/schemas/PaymentQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Payment" summary: Create a payment operationId: createPayment requestBody: content: application/json: schema: $ref: "#/components/schemas/Payment" responses: 200: description: The ID of the created payment content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Payment" summary: Update a payment operationId: updatePayment requestBody: content: application/json: schema: $ref: "#/components/schemas/Payment" responses: 200: description: The ID of the updated payment content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /payment/{id}: get: tags: - "Payment" summary: Get a payment by ID operationId: getPayment parameters: - name: id in: path description: The payment ID to get required: true schema: type: string responses: 200: description: A payment content: application/json: schema: $ref: "#/components/schemas/Payment" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "Payment" summary: Modify a payment operationId: patchPayment parameters: - name: id in: path description: The payment ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /person: get: tags: - "Person" summary: Query persons operationId: queryPersons parameters: - name: q in: query description: The NQL query to find persons required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of persons content: application/json: schema: $ref: "#/components/schemas/PersonQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Person" summary: Create a person operationId: createPerson requestBody: content: application/json: schema: $ref: "#/components/schemas/Person" responses: 200: description: The ID of the created person content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Person" summary: Update a person operationId: updatePerson requestBody: content: application/json: schema: $ref: "#/components/schemas/Person" responses: 200: description: The ID of the updated person content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /person/{id}: get: tags: - "Person" summary: Get a person by ID operationId: getPerson parameters: - name: id in: path description: The person ID to get required: true schema: type: string responses: 200: description: A person content: application/json: schema: $ref: "#/components/schemas/Person" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "Person" summary: Modify a person operationId: patchPerson parameters: - name: id in: path description: The person ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project: get: tags: - "Project" summary: Query projects operationId: queryProjects parameters: - name: q in: query description: The NQL query to find projects required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of projects content: application/json: schema: $ref: "#/components/schemas/ProjectQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "Project" summary: Create a project operationId: createProject requestBody: content: application/json: schema: $ref: "#/components/schemas/Project" responses: 200: description: The ID of the created project content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Project" summary: Update a project operationId: updateProject requestBody: content: application/json: schema: $ref: "#/components/schemas/Project" responses: 200: description: The ID of the updated project content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project/{id}: get: tags: - "Project" summary: Get a project by ID operationId: getProject parameters: - name: id in: path description: The project ID to get required: true schema: type: string responses: 200: description: A project content: application/json: schema: $ref: "#/components/schemas/Project" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "Project" summary: Modify a project operationId: patchProject parameters: - name: id in: path description: The project ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object example: name: New Project Name dynamics.do_e8a5de20bb374fd192dfc329ddf93cdb: Dynamic Field Value responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project/{id}/menuitems: get: tags: - "Project" summary: Get a project menu by project ID operationId: getProjectMenu parameters: - name: id in: path description: The project ID to get menu items required: true schema: type: string responses: 200: description: An array of project menu items content: application/json: schema: type: array items: $ref: "#/components/schemas/ProjectMenuItem" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Project" summary: Save a project menu operationId: setProjectMenu parameters: - name: id in: path description: The project ID to set menu items required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/ProjectMenuItem" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project/{id}/additionalforms: get: tags: - "Project" summary: Get additional dynamic forms for a project operationId: getProjectDynamicForms parameters: - name: id in: path description: The project ID to get additional forms required: true schema: type: string responses: 200: description: The additional forms on the project content: application/json: schema: type: array items: $ref: "#/components/schemas/DynamicForm" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project/{id}/menuitem: post: tags: - "Project" summary: Add a single menu item to a project operationId: addSingleMenuItemProject parameters: - name: id in: path description: The project ID to add the menu item required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ProjectMenuItem" responses: 200: description: The ID of the new menu item content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project/{id}/teammember: post: tags: - "Project" summary: Add a single team member to a project operationId: addSingleTeamMemberProject parameters: - name: id in: path description: The project ID to add the team member required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ProjectTeamMember" responses: 200: description: The ID of the additional name content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project/{projectId}/teammember/{userId}: patch: tags: - "Project" summary: Modify a team member on a project operationId: patchProjectTeamMember parameters: - name: projectId in: path description: The project ID to modify required: true schema: type: string - name: userId in: path description: The user ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /project/menuitem/{id}: patch: tags: - "Project" summary: Modify a project menu item operationId: patchProjectMenuItem parameters: - name: id in: path description: The project menu item ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /request: post: tags: - "Request" summary: "Create a new request bundle" operationId: createRequest requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestBundle" responses: 200: description: The ID of the created request bundle content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "Request" summary: "Update a request bundle" operationId: updateRequest requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestBundle" responses: 200: description: The ID of the updated request bundle content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /request/draft: post: tags: - "Request" summary: "Create a new draft request bundle" operationId: createRequestDraft requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestBundle" responses: 200: description: The ID of the created request bundle content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /request/requester/email: put: tags: - "Request" summary: "Update a request bundle requester by email address" operationId: updateRequesterByEmail requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestBundle" responses: 200: description: The ID of the updated request bundle content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /request/requester/login: put: tags: - "Request" summary: "Update a request bundle requester by login name" operationId: updateRequesterByLogin requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestBundle" responses: 200: description: The ID of the updated request bundle content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /request/document: post: tags: - "Request" summary: Create a document suitable for inclusion into a request operationId: createRequestDocument requestBody: content: multipart/form-data: schema: properties: document: $ref: "#/components/schemas/Document" contents: type: string format: binary responses: 200: description: The ID of the document content: text/plain: schema: type: string default: description: error content: application/json: schema: $ref: "#/components/schemas/Error" /session: post: tags: - "Session" summary: Create a session operationId: createSession requestBody: required: true content: application/x-www-form-urlencoded: schema: properties: username: type: string password: type: string required: - username - password responses: 200: description: The ID of the session content: text/plain: schema: type: string default: description: error content: application/json: schema: $ref: "#/components/schemas/Error" /session/{id}/logout: get: tags: - "Session" summary: End a session parameters: - name: id description: The session ID to end in: path required: true schema: type: string operationId: logout responses: 200: description: The session was closed default: description: error content: application/json: schema: $ref: "#/components/schemas/Error" /user: get: tags: - "User" summary: Query users operationId: queryUsers parameters: - name: q in: query description: The NQL query to find users required: true schema: type: string - name: pageSize in: query description: The number of results to return per page required: true schema: type: integer - name: page in: query description: The (zero-indexed) page number to return required: true schema: type: integer responses: 200: description: A paged array of users content: application/json: schema: $ref: "#/components/schemas/UserQueryResult" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" post: tags: - "User" summary: Create a user operationId: createUser requestBody: content: application/json: schema: $ref: "#/components/schemas/User" responses: 200: description: The ID of the created user content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "User" summary: Update a user operationId: updateUser requestBody: content: application/json: schema: $ref: "#/components/schemas/User" responses: 200: description: The ID of the updated user content: text/plain: schema: type: string default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /user/{id}: get: tags: - "User" summary: Get a user by ID operationId: getUser parameters: - name: id in: path description: The user ID to get required: true schema: type: string responses: 200: description: A user content: application/json: schema: $ref: "#/components/schemas/User" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" patch: tags: - "User" summary: Modify a user operationId: patchUser parameters: - name: id in: path description: The user ID to modify required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" /user/{id}/type: get: tags: - "User" summary: Get a user's type operationId: getUserType parameters: - name: id in: path description: The user ID to get type for required: true schema: type: string responses: 200: description: A user type content: application/json: schema: $ref: "#/components/schemas/UserType" default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" put: tags: - "User" summary: Set a user's type operationId: setUserType parameters: - name: id in: path description: The user ID to set type for required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UserType" responses: 200: description: Success default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" components: schemas: AdditionalParty: properties: company: $ref: "#/components/schemas/Company" notes: type: string effectiveDate: type: string format: date-time expirationDate: type: string format: date-time ApiDynamicFormMetadata: properties: configId: type: string name: type: string description: type: string apiName: type: string ApiFieldMetadata: properties: apiName: type: string label: type: string type: type: string length: type: integer quickTip: type: string apiMappingKey: type: string required: type: boolean updatable: type: boolean creatable: type: boolean hidden: type: boolean listValues: type: array items: type: string ApiObjectMetadata: properties: name: type: string parent: type: string configId: type: string apiName: type: string children: type: array items: type: string dynamicForms: type: array items: $ref: "#/components/schemas/ApiDynamicFormMetadata" fields: type: array items: $ref: "#/components/schemas/ApiFieldMetadata" dynamicFields: type: array items: $ref: "#/components/schemas/ApiFieldMetadata" BulkCreateRequestCompany: properties: object: $ref: "#/components/schemas/Company" referenceId: type: string BulkCreateRequestContract: properties: object: $ref: "#/components/schemas/Contract" referenceId: type: string BulkCreateResult: properties: id: type: string referenceId: type: string success: type: boolean message: type: string ClauseQueryResult: properties: clauseList: type: array items: $ref: "#/components/schemas/Clause" totalCount: type: integer format: int64 CompanyPersonQueryResult: properties: companyPersonList: type: array items: $ref: "#/components/schemas/CompanyPerson" totalCount: type: integer format: int64 CompanyQueryResult: properties: companyList: type: array items: $ref: "#/components/schemas/Company" totalCount: type: integer format: int64 ContractQueryResult: properties: contractList: type: array items: $ref: "#/components/schemas/Contract" totalCount: type: integer format: int64 DocumentQueryResult: properties: documentList: type: array items: $ref: "#/components/schemas/Document" totalCount: type: integer format: int64 DynamicFormQueryResult: properties: formList: type: array items: $ref: "#/components/schemas/DynamicForm" totalCount: type: integer format: int64 EventQueryResult: properties: eventList: type: array items: $ref: "#/components/schemas/Event" totalCount: type: integer format: int64 PaymentQueryResult: properties: paymentList: type: array items: $ref: "#/components/schemas/Payment" totalCount: type: integer format: int64 PersonQueryResult: properties: personList: type: array items: $ref: "#/components/schemas/Person" totalCount: type: integer format: int64 ProjectQueryResult: properties: projectList: type: array items: $ref: "#/components/schemas/Project" totalCount: type: integer format: int64 UserQueryResult: properties: userList: type: array items: $ref: "#/components/schemas/User" totalCount: type: integer format: int64 Clause: properties: id: type: string familyId: type: string revision: type: integer name: type: string description: type: string category: type: string type: type: string text: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string deleted: type: boolean securityId: type: string securityLevel: type: integer securityName: type: string securityDescription: type: string clauseGroupName: type: string isLatestRevision: type: boolean Company: properties: id: type: string name: type: string number: type: string group: type: string taxId: type: string status: type: string dunsNumber: type: string type: type: string category: type: string url: type: string address1: type: string address2: type: string city: type: string state: type: string postalCode: type: string country: type: string phoneAreaCode: type: string phoneCountryCode: type: string phoneExtension: type: string phoneNumber: type: string faxAreaCode: type: string faxCountryCode: type: string faxExtension: type: string faxNumber: type: string dynamics: $ref: "#/components/schemas/DynamicItem" createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string legalEntity: type: boolean description: type: string CompanyAdditionalName: properties: id: type: string additionalName: type: string description: type: string type: type: string effectiveDate: type: string format: date-time createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string CompanyPerson: properties: company: $ref: "#/components/schemas/Company" companyId: type: string functions: type: array items: type: string id: type: string prefix: type: string firstName: type: string middleName: type: string lastName: type: string title: type: string addressLine1: type: string addressLine2: type: string mailStop: type: string city: type: string state: type: string postalCode: type: string country: type: string emailAddress: type: string workCountryCode: type: string workAreaCode: type: string workNumber: type: string workExtension: type: string cellCountryCode: type: string cellAreaCode: type: string cellNumber: type: string cellExtension: type: string homeCountryCode: type: string homeAreaCode: type: string homeNumber: type: string homeExtension: type: string faxCountryCode: type: string faxAreaCode: type: string faxNumber: type: string faxExtension: type: string notes: type: string organization: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string CompanyRelationship: properties: id: type: string relatedCompanyId: type: string relationshipType: type: string notes: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string Contract: properties: company: $ref: "#/components/schemas/Company" id: type: string group: type: string number: type: string value: type: number format: double agreementType: type: string proposedValue: type: number format: double types: type: array items: type: string location: type: string purpose: type: string legalEntity: type: string originalExpirationDate: type: string format: date-time effectiveDate: type: string format: date-time currentExpirationDate: type: string format: date-time noticeDate: type: string format: date-time renewalInterval: type: integer format: int32 noticePeriod: type: integer format: int32 termType: type: string status: type: string currency: type: string parentContractId: type: string originalCompany: type: string description: type: string familyId: type: string dynamics: $ref: "#/components/schemas/DynamicItem" createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string ContractLocation: properties: id: type: string companyLocationId: type: string attentionTo: type: string notes: type: string attnEmail: type: string attnPhoneCountryCode: type: string attnPhoneAreaCode: type: string attnPhoneNumber: type: string attnPhoneExtension: type: string attnFaxCountryCode: type: string attnFaxAreaCode: type: string attnFaxNumber: type: string attnFaxExtension: type: string addressType: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string ContractResponsibility: properties: responsibilityName: type: string personId: type: string Document: properties: id: type: string type: type: string familyId: type: string revisionNumber: type: integer format: int32 fileName: type: string fileType: type: string fileSize: type: integer format: int32 author: type: string description: type: string effectiveDate: type: string format: date-time expirationDate: type: string format: date-time objects: type: array items: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string DynamicForm: properties: id: type: string configId: type: string objectId: type: string dynamics: $ref: "#/components/schemas/DynamicItem" createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string Event: properties: id: type: string objectId: type: string name: type: string column: type: string description: type: string ownerId: type: string status: type: string date: type: string format: date-time warnDays: type: integer format: int32 frequencyType: type: string frequency: type: integer format: int32 endDate: type: string format: date-time notificationIds: type: array items: type: string notificationMessage: type: string documentIds: type: array items: type: string reminder: type: boolean reminderDays: type: integer format: int32 reminderIds: type: array items: type: string reminderMessage: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string ListComboItem: properties: id: type: string name: type: string description: type: string treeItems: type: array items: $ref: "#/components/schemas/ListComboItem" createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string Location: properties: id: type: string name: type: string state: type: string addressLine1: type: string addressLine2: type: string city: type: string postalCode: type: string country: type: string webAddress: type: string phoneCountryCode: type: string phoneAreaCode: type: string phoneNumber: type: string phoneExtension: type: string faxCountryCode: type: string faxAreaCode: type: string faxNumber: type: string faxExtension: type: string type: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string Payment: properties: id: type: string invoiceNumber: type: string invoiceDate: type: string format: date-time invoiceDueDate: type: string format: date-time paidDate: type: string format: date-time paidAmount: type: number format: double referenceNumber: type: string transactionId: type: string notes: type: string streamType: type: integer format: int32 streamId: type: string contractId: type: string streamName: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string Person: properties: functions: type: array items: type: string type: type: string id: type: string prefix: type: string firstName: type: string middleName: type: string lastName: type: string title: type: string addressLine1: type: string addressLine2: type: string mailStop: type: string city: type: string state: type: string postalCode: type: string country: type: string emailAddress: type: string workCountryCode: type: string workAreaCode: type: string workNumber: type: string workExtension: type: string cellCountryCode: type: string cellAreaCode: type: string cellNumber: type: string cellExtension: type: string homeCountryCode: type: string homeAreaCode: type: string homeNumber: type: string homeExtension: type: string faxCountryCode: type: string faxAreaCode: type: string faxNumber: type: string faxExtension: type: string notes: type: string organization: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string Project: properties: id: type: string name: type: string description: type: string status: type: string group: type: string type: type: string startDate: type: string format: date-time endDate: type: string format: date-time teamMembers: type: array items: $ref: "#/components/schemas/ProjectTeamMember" dynamics: $ref: "#/components/schemas/DynamicItem" createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string ProjectMenuItem: properties: nodeId: type: string parentId: type: string orderIndex: type: string objectId: type: string objectType: type: string folderName: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string ProjectTeamMember: properties: user: $ref: "#/components/schemas/User" modify: type: boolean documents: type: boolean documentUpload: type: boolean Request: properties: id: type: string requestConfigName: type: string company: $ref: "#/components/schemas/Company" contract: $ref: "#/components/schemas/Contract" responsibilities: type: array items: $ref: "#/components/schemas/ContractResponsibility" dynamicForms: type: array items: $ref: "#/components/schemas/DynamicForm" requestDocuments: type: array items: type: string RequestBundle: properties: id: type: string requests: type: array items: $ref: "#/components/schemas/Request" requestBundleConfigName: type: string companyId: type: string companyName: type: string requesterName: type: string requesterEmail: type: string User: properties: roles: type: array items: type: string functions: type: array items: type: string loginName: type: string password: type: string forcePasswordChange: type: boolean disabled: type: boolean id: type: string personId: type: string prefix: type: string firstName: type: string middleName: type: string lastName: type: string title: type: string addressLine1: type: string addressLine2: type: string mailStop: type: string city: type: string state: type: string postalCode: type: string country: type: string emailAddress: type: string workCountryCode: type: string workAreaCode: type: string workNumber: type: string workExtension: type: string cellCountryCode: type: string cellAreaCode: type: string cellNumber: type: string cellExtension: type: string homeCountryCode: type: string homeAreaCode: type: string homeNumber: type: string homeExtension: type: string faxCountryCode: type: string faxAreaCode: type: string faxNumber: type: string faxExtension: type: string notes: type: string organization: type: string createdOn: type: string format: date-time lastUpdatedOn: type: string format: date-time createdBy: type: string lastUpdatedBy: type: string UserType: properties: type: type: string DynamicItem: type: object additionalProperties: type: object Error: required: - errorMessage - exceptionClass properties: errorMessage: type: string exceptionClass: type: string