API

Table of Contents

Query
Mutation
Subscription
Objects
Inputs
Enums
Scalars
- Boolean
- Date
- DateTime
- Float
- ID
- Int
- JSON
- String
- Upload
Interfaces
Unions
- RequisitionSubscription
- SearchResultItems

Query

Field	Type	Description
validateRecoverPasswordToken	SuccessResponse	Valida se o recoverPasswordToken passado está válido
token	String!
getSignInInfo	GetSignInInfoResponse	Retorna informações de signin de uma organização
subDomain	String
organizationId	ID
getOrganizationsByEmail	[OrganizationSignInInfo!]!	Retorna lista de organizações vinculadas a um email
email	String!
clientToken	String!
authorizationOAuthCheckStatus	OAuthCheckStatusResponse!	Query to check status of user oauth
authorizationOAuthGetUrl	AuthorizationOAuthGetUrlResponse!
validateAutomationConditions	ValidationResult!
analyzeAutomationImpact	AutomationImpactAnalysis!
Dashboard_contractsTermStatusOverview	Dashboard_ContractsTermStatusOverview_Output!
Dashboard_getMetabaseUrls	Dashboard_GetMetabaseUrls_Output	Generate Metabase dashboard URLs for requisition and contract dashboards. Returns null if organization doesn't have Metabase configured
requisitionsResume	RequisitionResumeResult!	Resume of requisitions used in the dashboard
options	DashboardInput!
requisitionsSlaOverviewStatus	RequisitionsSlaOverviewStatusResult!	SLA status overview of the requisitions
requisitionsOverviewChart	RequisitionsOverviewChartResultList!	Overview of requisitions used in the chart, grouped by date
options	DashboardInput!
requisitionsSlaStatusByAssignee	RequisitionsSlaStatusByAssigneeResultList!	SLA status grouped by assignee
options	RequisitionsSlaStatusByAssigneeOptions!
Contract_getContractBySlug	Contract!
slug	ID!
Contract_getContractById	Contract!
id	ID!
Contract_getAISummary	String!
slug	ID!
Contract_list	ContractList!
input	ContractListInput
Contract_quickSearch	ContractList!
input	ContractQuickSearchInput!
Contract_listContractAttachments	ListContractAttachmentsResponse!
input	ContractAttachmentsListInput!
Contract_getUrlToDownloadContractFile	String!
contractFileId	ID!
Contract_getUrlToViewContractFile	String!
contractFileId	ID!
Contract_listContractStatuses	[ContractStatus!]!
effectInitRequisitionList	EffectInitRequisitionList_Output
input	EffectInitRequisitionList_Input
effectInitRequisition	EffectInitRequisition
input	EffectInitRequisition_Input!
effectRequisitionAutomationListReorder	[EffectRequisitionAutomation!]!
input	EffectRequisitionAutomationListReorderInput!
listInboxEmails	ListInboxEmailResponse
options	ListInboxEmailsOptions
form	Form
organization	Organization
hasOrganization	Boolean
input	HasOrganizationInput!
Organization_listContractRenewalReminders	[ContractRenewalReminder!]!
getOCRTemplateFields	OCRTemplateFields
id	ID!
listOCRTemplateFields	[OCRTemplateFields!]
Requisition_list	RequisitionList!
input	RequisitionListInput
requisition	Requisition!
requisitionId	ID!
requisitionsCount	RequisitionsCount
options	RequisitionsCountOptions!
requisitionFile	RequisitionFile!
input	RequisitionFileInput!
requisitionFiles ⚠️	RequisitionFileList!	⚠️ DEPRECATED Use 'requisitionFilesList' query
requisitionId	ID!
cursor	String
limit	Int!
sort	RequisitionFileSortParameter
requisitionFilesList	[RequisitionFile!]!
input	RequisitionFilesListInput!
downloadRequisitionFile	String!
requisitionFileId	ID!
requisitionFileVersions	[RequisitionFile!]!
input	RequisitionFileVersionsInput!
requisitionMessages	[RequisitionMessage]!
requisitionId	ID!
cursor	String
limit	Int!
requisitionChatGroupMessages	[RequisitionMessage]!
requisitionId	ID!
requisitionChatGroupId	ID!
cursor	String
limit	Int!
requisitionStatuses	[RequisitionStatus!]!
requisitionStatusCategories	[RequisitionStatusCategory!]!
userByInviteToken	User	Fetches user by invite token
inviteToken	String!
User_listEvents	User_ListEvents_Output!	Lists user events (admins only)
input	User_ListEvents_Input!
user	User	Busca um usuário específico por ID
id	ID!
users	UserList	Lista usuários
options	UserListOptions
search	SearchResult!
input	SearchInput!

Mutation

Field	Type	Description
changePasswordWithToken	ChangePasswordWithTokenResponse	Troca a senha do usuário a partir de seu token
input	changePasswordWithTokenInput!
signIn	SignInResponse	Realiza o login do usuário
input	SignInInput!
signUp	SignUpResponse	Registra definitivamente o usuário no sistema
input	SignUpInput!
recoverPassword	SuccessResponse	Envia email para recuperar senha
email	String!
organizationId	ID!
authorizationOAuthCreateToken	SuccessResponse!
code	String!
fixAutomationReferences	FixAutomationReferencesResult!	Fix broken automation references by updating ASTs and custom fields. All operations are performed in a single transaction.
input	FixAutomationReferencesInput!
conditionCreate	Condition!
input	ConditionCreateInput!
Contract_updateContractBasicFields ⚠️	Contract!	⚠️ DEPRECATED Use the 'Contract_updateContractBasicFields' from Core-API instead.
input	EditBasicFieldsInput!
Contract_finishContract ⚠️	Contract!	⚠️ DEPRECATED Use the 'Contract_finishContract' from Core-API instead.
contractId	ID!
Contract_reopenContract ⚠️	Contract!	⚠️ DEPRECATED Use the 'Contract_reopenContract' from Core-API instead.
contractId	ID!
Contract_deleteContract ⚠️	Deletion!	⚠️ DEPRECATED Use the 'Contract_cancelContract' from Core-API instead.
contractId	ID!
Contract_upsertCustomField	CustomField!
input	ContractUpsertCustomFieldInput!
Contract_deleteCustomField	SuccessResponse!
customFieldId	ID!
Contract_deleteCustomFieldChild	SuccessResponse!
customFieldChildId	ID!
Contract_importContracts	Contract_importContracts_Output!
input	ImportContractsInput!
Contract_uploadContractAttachments	[ContractFile!]!
input	UploadContractAttachmentsInput!
Contract_deleteContractAttachment	Deletion!
contractFileId	ID!
Contract_replaceContractFile	ContractFile!
input	ReplaceContractFileInput!
Contract_createContractStatus	ContractStatus!
input	ContractStatusCreateInput!
Contract_deleteContractStatus	ContractStatus!
input	ContractStatusDeleteInput!
Contract_setContractStatusDefault	[ContractStatus]!
input	ContractStatusSetDefaultInput!
Contract_updateContractStatus	ContractStatus!
input	ContractStatusUpdateInput!
effectInitRequisitionCreate	EffectInitRequisition!
input	EffectInitRequisitionCreateInput!
effectInitRequisitionDelete	[EffectInitRequisition!]!
input	EffectInitRequisitionDeleteInput!
effectInitRequisitionListReorder	[EffectInitRequisition!]!
input	EffectInitRequisitionListReorderInput!
effectInitRequisitionUpdate	EffectInitRequisition!
input	EffectInitRequisitionUpdateInput!
effectInitRequisitionDuplicate	[EffectInitRequisition!]!
input	EffectInitRequisitionDuplicateInput!
deleteRequisitionAutomation	[EffectRequisitionAutomation!]!
input	deleteRequisitionAutomationInput!
effectRequisitionAutomationUpdate	EffectRequisitionAutomation!
input	EffectRequisitionAutomationUpdateInput!
effectRequisitionAutomationListFromStatusReorder	[EffectRequisitionAutomation!]!
input	EffectRequisitionAutomationListFromStatusReorderInput!
deleteOrganizationAvatar	Deletion
updateOrganizationBasicInfo	Organization	Atualiza as informações básicas de uma organização
input	UpdateOrganizationBasicInfoInput!
uploadOrganizationAvatar	Organization
input	UploadOrganizationAvatarInput!
inviteUsers	[User]
input	InviteUserInput!
Organization_createContractRenewalReminder	ContractRenewalReminder!
input	Organization_createContractRenewalReminder_Input!
Organization_deleteContractRenewalReminder	ContractRenewalReminder!
input	Organization_deleteContractRenewalReminder_Input!
Organization_setContractRenewalRemindersEnabledStatusOnOrganization	Organization!
input	Organization_SetContractRemindersEnabledStatusOnOrganization_Input!
Organization_updateContractRenewalReminder	ContractRenewalReminder!
input	Organization_updateContractRenewReminder_Input!
Organization_setRequisitionSharedLinkEnabledStatus	Organization!
input	Organization_setRequisitionSharedLinkEnabledStatus_Input!
Organization_upsertDefaultRequisitionView	Organization!
input	Organization_upsertDefaultRequisitionView_Input!
Organization_deleteDefaultRequisitionView	Organization!
Organization_upsertDefaultContractView	Organization!
input	Organization_upsertDefaultContractView_Input!
Organization_deleteDefaultContractView	Organization!
createOCRTemplateFields	OCRTemplateFields!
input	CreateOCRTemplateFieldsInput!
updateOCRTemplateFields	OCRTemplateFields!
id	ID!
input	UpdateOCRTemplateFieldsInput!
deleteOCRTemplateFields	Deletion!
id	ID!
createRequisition	CreateRequisitionResponse
deleteRequisition	Deletion
requisitionId	ID!
reopenRequisition	Requisition!
requisitionId	ID!
requisitionFinish	Requisition!
input	RequisitionFinishInput!
Requisition_addParticipantsOnRequisition	Requisition!
input	RequisitionAddParticipantsInput!
Requisition_removeParticipantFromRequisition	Requisition!
input	RequisitionRemoveParticipantInput!
Requisition_batchUpdateRequisitionsParticipants	SuccessResponse!
input	RequisitionBatchUpdateParticipantsInput!
Requisition_batchUpdateAssignees	RequisitionBatchUpdateAssigneesResult!
input	RequisitionBatchUpdateAssigneesInput!
Requisition_batchUpdateStatus	RequisitionBatchUpdateStatusResult!
input	RequisitionBatchUpdateStatusInput!
requisitionUpdateSLA	Requisition!
input	RequisitionUpdateSLAInput!
requisitionUpdateStatus	Requisition!
input	RequisitionUpdateStatusInput!
Requisition_addAssignee	Requisition!
input	RequisitionAddAssigneeInput!
Requisition_removeAssignee	Requisition!
input	RequisitionRemoveAssigneeInput!
Requisition_deleteCustomField	Requisition!
input	Requisition_DeleteCustomField_Input!
Requisition_upsertCustomField	Requisition!
input	Requisition_UpsertCustomField_Input!
Requisition_createRequisitionFromSharedLink	SuccessResponse!
input	Requisition_createRequisitionFromSharedLink_Input!
Requisition_createRequisitionFromDocs	Requisition!
input	Requisition_createRequisitionFromDocs_input!
Requisition_fillDocsForm	Requisition!
input	Requisition_fillDocsForm_input!
Requisition_fillDocsFormFromSharedLink	SuccessResponse!
input	Requisition_fillDocsFormFromSharedLink_Input!
Requisition_createFullRequisition	Requisition!
input	Requisition_createFullRequisition_Input!
Requisition_refreshSharedLinkToken ⚠️	SuccessResponse!	⚠️ DEPRECATED Use Requisition_refreshToken mutation instead.
input	Requisition_refreshSharedLinkToken_Input!
Requisition_refreshToken	SuccessResponse!
input	Requisition_refreshToken_Input!
Requisition_importFromNetlex	NetlexMigrationResult!
input	Requisition_importFromNetlex_Input!
Requisition_restoreRequisition	Requisition!
input	Requisition_restoreRequisition_Input!
Requisition_changeRequester	Requisition!
input	Requisition_changeRequester_Input!
Requisition_markAsSeen	Boolean
requisitionId	ID!
uploadRequisitionFiles	[RequisitionFile!]!
input	UploadRequisitionFilesInput!
RequisitionFile_saveNewVersion	RequisitionFile!
input	RequisitionFile_saveNewVersion_Input!
deleteRequisitionFile	Deletion
requisitionFileId	ID!
sendRequisitionMessage	RequisitionMessage!
requisitionId	ID!
messageText	String!
requisitionMessageSendExternal	SuccessResponse!
input	RequisitionMessageSendExternalInput!
sendRequisitionMessageWithFiles	RequisitionMessage!
input	SendRequisitionMessageWithFilesInput!
deleteRequisitionMessage	Deletion
requisitionMessageId	ID!
sendRequisitionChatGroupMessage	RequisitionMessage!
requisitionId	ID!
messageText	String!
requisitionChatGroupId	ID!
sendRequisitionChatGroupMessageWithFiles	RequisitionMessage!
input	SendRequisitionChatGroupMessageWithFilesInput!
deleteRequisitionChatGroupFile	Deletion
input	deleteRequisitionChatGroupFileInput!
requisitionStatusCreate	RequisitionStatus!
input	RequisitionStatusCreateInput!
requisitionStatusDelete	RequisitionStatus!
input	RequisitionStatusDeleteInput!
requisitionStatusSetDefault	[RequisitionStatus]!
input	RequisitionStatusSetDefaultInput!
requisitionStatusUpdate	RequisitionStatus!
input	RequisitionStatusUpdateInput!
deleteUserAvatar	User	Removes the user's avatar image
changeUserPassword	SuccessResponse	Changes the logged-in user's password
input	ChangeUserPasswordInput!
changeUserRole	User	Changes another user's role
input	ChangeUserRoleInput!
updateOrganizationUserBasicInfo	User	Allows organization admins to update another user's basic info
input	UpdateOrganizationUserBasicInfoInput!
deleteUser	Deletion	Remove um usuário
id	ID!
uploadUserAvatar	User	Salva a imagem de avatar do usuário
input	UploadUserAvatarInput!
updateUserBasicInfo	User	Atualiza as informações básicas de um usuário
input	UpdateUserBasicInfoInput!
AI_faq	AI_FaqOutput!
input	AI_FaqInput!
AI_chat	AIChatOutput!
input	AIChatInput!

Subscription

Field	Type	Description
requisition	RequisitionSubscription!
requisitionId	ID!
requisitions	RequisitionSubscription!
requisitionFiles	SubscriptionRequisitionFilesResponse!
requisitionId	ID!
requisitionMessage	SubscriptionRequisitionMessageResponse!
requisitionId	ID!
me	User!	User subscription for the logged-in user

Objects

AIChatOutput

Field	Argument	Type	Description
response		String!
threadId		String!

AI_FaqOutput

Field	Argument	Type	Description
response		String!
threadId		String!

AffectedAutomation

Field	Argument	Type	Description
automationId		ID!
automationLabel		String!
issues		[AutomationIssue!]!

AffectedAutomationReference

Field	Argument	Type	Description
automationId		ID!
automationLabel		String!

AffectedField

Field	Argument	Type	Description
customFieldId		ID!
customFieldLabel		String!
reference		String!
value		String!
issueType		ValidationIssueType!

AffectedRequisition

Field	Argument	Type	Description
requisitionId		ID!
affectedFields		[AffectedField!]!

AffectedRequisitionReference

Field	Argument	Type	Description
requisitionId		ID!
customFields		[CustomFieldReference!]!

AffectedUser

User affected by the event

Field	Argument	Type	Description
id		ID!
name		String
email		String

Authentication

An authentication method of an organization

Field	Argument	Type	Description
id		String!
grantAccessTo		[String]!
priority		Int!
ssoUrl		String

AuthenticationMethodsByOrganization

A conjuct of authentication methods an Organization has

Field	Argument	Type	Description
methods		[Authentication!]!

AuthenticationOrganization

Models an authentication by organization

Field	Argument	Type	Description
id		ID!
organizationId		ID!
authenticationId		AuthorizationEnum!
grantAccessTo		[String]!
priority		Int!

AuthorizationOAuthGetUrlResponse

Field	Argument	Type	Description
url		String!

AutomationImpactAnalysis

Field	Argument	Type	Description
organizationId		ID!
summary		ImpactSummary!
affectedAutomations		[AffectedAutomation!]!
affectedRequisitions		[AffectedRequisition!]!
brokenReferences		[BrokenReference!]!

AutomationIssue

Field	Argument	Type	Description
reference		String!
referenceLabel		String
values		[String!]!
issueType		ValidationIssueType!
message		String!
allowedValues		[String!]

BrokenReference

Field	Argument	Type	Description
reference		String!
referenceLabel		String
issueType		ValidationIssueType!
affectedValues		[String!]
allowedValues		[String!]
affectedAutomations		[AffectedAutomationReference!]!
affectedRequisitions		[AffectedRequisitionReference!]!

ChangePasswordWithTokenResponse

Token de autorização

Field	Argument	Type	Description
jwtToken		String!

Condition

Field	Argument	Type	Description
id		ID!
label		String!
ast		JSON!
organization		Organization!
creator		User!
createdAt		DateTime!
updatedAt		DateTime!

Contract

Field	Type	Description
id	ID!
slug	ID!
value	Float
currency	ContractCurrencyEnum!
effectiveDate	DateTime
expirationDate	DateTime
isFormAnswered	Boolean!
type	String
requestingArea	String
statusId	ID!
status	ContractStatus!
file	ContractFile
updatedAt	DateTime
createdAt	DateTime!
totalAttachments	Int!
customFields	[CustomField!]!
counterpart ⚠️	String	⚠️ DEPRECATED use counterparties list to get all counterpart
counterparties	[String]
participants	[ContractParticipant!]!
renewalReminders	[ContractRenewalReminder!]!
termStatus	TermStatusEnum!
createdFromRequisitionId	ID
amendments	[Contract!]
kind	ContractKindEnum!
parent	Contract
content	String
fillFieldsByAIStatus	FillFieldsByAIStatus

ContractFile

Field	Argument	Type	Description
createdAt		DateTime!
id		ID!
fileName		String!
fileExtension		String!
size		Int!
contractId		ID!
sender		User!
type		ContractFileTypeEnum!
signed		Boolean!

ContractList

Field	Argument	Type	Description
items		[Contract!]
totalItems		Int!

ContractParticipant

Represents a participant in a contract. A participant can be either a user or a user group (but not both).

Field	Type	Description
role	ContractParticipantRoleEnum!
user	User	The user participant. Null if this participant is a group.
group	UserGroup	The user group participant. Null if this participant is a user.

ContractRenewalReminder

Field	Argument	Type	Description
id		ID!
name		String!
timer		Int!
organization		Organization!

ContractStatus

Field	Argument	Type	Description
id		ID!
label		String!
category		ContractStatusCategoryEnum!
isDefault		Boolean!
isDisabled		Boolean!
isInitial		Boolean!
createdAt		DateTime!
updatedAt		DateTime!
contractsCount		Int!

Contract_importContracts_Output

Field	Argument	Type	Description
sheetLineErrors		[Int]

CreateRequisitionResponse

Field	Argument	Type	Description
id		ID!

CustomField

Field	Argument	Type	Description
children		[CustomFieldChild!]
id		ID!
label		String!
type		CustomFieldTypeEnum!
value		String!
originRefId		String

CustomFieldChild

Field	Argument	Type	Description
customFieldId		ID!
id		ID!
label		String!
type		CustomFieldChildTypeEnum!
value		String!
originRefId		String

CustomFieldLabelWithContractCount

Field	Argument	Type	Description
parentLabel		String
customFieldLabel		String!
totalContracts		Int!
isChild		Boolean!

CustomFieldLabelWithRequisitionCount

Field	Argument	Type	Description
parentLabel		String
customFieldLabel		String!
totalRequisitions		Int!
isChild		Boolean!

CustomFieldReference

Field	Argument	Type	Description
customFieldId		ID!
customFieldLabel		String!
value		String!

CustomRole

Field	Argument	Type	Description
id		ID!
name		String!
description		String
role		Role!
permissions		[CustomRolePermission]

CustomRolePermission

Field	Argument	Type	Description
resource		String!
action		String!

Dashboard_ContractsTermStatusOverview_Output

Field	Argument	Type	Description
UNDETERMINED		Int!
IN_EFFECT		Int!
WILL_BE_OUT_OF_EFFECT_SOON		Int!
OUT_OF_EFFECT		Int!

Dashboard_GetMetabaseUrls_Output

Field	Argument	Type	Description
requisitionDashboardUrl		String!	URL for the requisition dashboard with embedded authentication
contractDashboardUrl		String!	URL for the contract dashboard with embedded authentication

Deletion

Campo utilizado como resposta de mutations de delete

Field	Argument	Type	Description
success		Boolean!	Se foi deletado com sucesso

DocsForm

Field	Argument	Type	Description
hash		String!
name		String!

DocxFileTemplate

Field	Argument	Type	Description
id		ID!
name		String!
latestVersion		DocxFileTemplateVersion!

DocxFileTemplateVersion

Field	Argument	Type	Description
createdAt		Date!
docxFileTemplateID		ID!
uploader		User!
version		Int!

EffectInitRequisition

Field	Argument	Type	Description
id		ID!
label		String!
assignee		User
assignees		[User]
participants		[User]!
docxFileTemplates		[DocxFileTemplate!]
condition		Condition
organization		Organization!
priority		Int!
creator		User!
createdAt		DateTime!
updatedAt		DateTime!
sla		Sla
status		RequisitionStatus
assigneeType		AssigneeTypeEnum!

EffectInitRequisitionList_Output

Field	Argument	Type	Description
totalItems		Int!
items		[EffectInitRequisition!]!

EffectRequisitionAutomation

Field	Argument	Type	Description
id		ID!
label		String!
assignee		User
assignees		[User]
customFieldEmailLabel		String
condition		Condition
organization		Organization!
priority		Int!
creator		User!
createdAt		DateTime!
updatedAt		DateTime!
status		RequisitionStatus
fromStatus		RequisitionStatus
assigneeType		EffectRequisitionAutomationAssigneeType!
slaDays		Int
slaRule		SlaRuleEnum
triggerType		EffectRequisitionAutomationTriggerType!

Email

Field	Argument	Type	Description
threadId		String!
sender		EmailSender!
sentDate		DateTime!
snippet		String!
subject		String!
labelIds		[LabelIdsEnum]!
requisitionId		String

EmailSender

Field	Argument	Type	Description
name		String
email		String

EventActor

Actor that performed the event

Field	Argument	Type	Description
id		ID!
name		String
type		String

FixAutomationReferencesResult

Field	Argument	Type	Description
success		Boolean!
summary		FixSummary!
errors		[FixError!]!
updatedAutomations		[UpdatedAutomation!]
updatedCustomFields		[UpdatedCustomField!]

FixError

Field	Argument	Type	Description
code		String!
message		String!
details		String

FixSummary

Field	Argument	Type	Description
conditionsUpdated		Int!
customFieldsUpdated		Int!
automationsFixed		Int!
requisitionsAffected		Int!

Form

Representa um Formulário padrão da Organização

Field	Argument	Type	Description
typeformFormId		String!
questions		[FormQuestion]!

FormQuestion

A question from a form, based on a payload of Typeform

Field	Argument	Type	Description
id		String!
title		String!
type		FormQuestionTypeEnum!
properties		FormQuestionProperties

FormQuestionChoices

Field	Argument	Type	Description
id		String!
label		String!

FormQuestionProperties

Field	Argument	Type	Description
allowMultipleSelection		Boolean!
choices		[FormQuestionChoices]!

GetSignInInfoResponse

Field	Argument	Type	Description
organization		OrganizationSignInInfo

ImpactSummary

Field	Argument	Type	Description
totalAutomations		Int!
affectedAutomations		Int!
totalRequisitions		Int!
affectedRequisitions		Int!
totalBrokenReferences		Int!
totalIssues		Int!

Language

Field	Argument	Type	Description
id		String
name		String

ListContractAttachmentsResponse

Field	Argument	Type	Description
items		[ContractFile!]
totalItems		Int!

ListInboxEmailResponse

Field	Argument	Type	Description
items		[Email]!
totalItems		Int
nextPageToken		String

NetlexMigrationResult

Field	Argument	Type	Description
totalDocuments		Int!
requisitionsCreated		[NetlexRequisitionCreated!]!

NetlexRequisitionCreated

Field	Argument	Type	Description
requisitionId		ID!
netlexDocumentId		String!
netlexAttachmentsIds		String

OAuthCheckStatusResponse

Field	Argument	Type	Description
status		OAuthCheckStatusEnum!

OCRTemplateFields

Field	Argument	Type	Description
id		ID!
name		String!
fields		JSON!
createdAt		DateTime!
updatedAt		DateTime!

Organization

Field	Type	Description
activeContractsCustomFieldLabels	[String!]!
activeContractsCustomFieldLabelsWithCount	[CustomFieldLabelWithContractCount!]!
sortOrder	SortOrder	Order by totalContracts (ASC: less used first, DESC: most used first)
activeRequisitionsCustomFieldLabels	[String!]!
activeRequisitionsCustomFieldLabelsWithCount	[CustomFieldLabelWithRequisitionCount!]!
sortOrder	SortOrder	Order by totalRequisitions (ASC: less used first, DESC: most used first)
id	ID!
name	String!
registrationNumber	String!
subDomain	String!
prefix	String!
profilePictureUrl	String
areas	[String!]!
form ⚠️	Form	⚠️ DEPRECATED Use `Organization_getForm` from core-api instead.
contractForm ⚠️	Form	⚠️ DEPRECATED Use `Organization_getForm` from core-api instead.
requisitionForm ⚠️	Form	⚠️ DEPRECATED Use `Organization_getForm` from core-api instead.
language	Language
users	UserList
options	UserListOptions
isDisabled	Boolean!
hexColor	String
SLA	Int
slaRule	SlaRuleEnum
createdAt	DateTime
updatedAt	DateTime
authentication	AuthenticationMethodsByOrganization!
contractRenewalRemindersEnabledStatus	Boolean!	Whether the `Organization` have `ContractRenewalReminder`(s) which will be sent to `User`(s) should the timer be met.
contractRenewalReminders	[ContractRenewalReminder!]!	List of `ContractRenewalReminders` which `Users` of this `Organization` can be sent.
requisitionSharedLinkEnabledStatus	Boolean!
requisitionFormId	String
contractFormId	String
requisitionFormProvider	String!
contractFormProvider	String!
linteSignEnvelopeCount	Int
organizationForms	[DocsForm]
requisitionWithoutForm	Boolean!
highlightedLabel	String
subjectAsHighlightedLabel	Boolean!
defaultRequisitionView	JSON
defaultContractView	JSON
contractTypes	[OrganizationContractType]
isOrganizationTest	Boolean
totalContractsAvailable	Int
totalFlowsAvailable	Int
totalFlowsConsumed	Int
isFreeTrial	Boolean
faqAssistantAI	String
ssoDefaultCustomRoleId	String
requisitionCustomFieldVisibility	[RequisitionCustomFieldVisibility]
metadata	JSON

OrganizationContractType

Field	Argument	Type	Description
id		ID!
type		String!

OrganizationForm

Field	Argument	Type	Description
id		ID!
formId		String!
questionRefId		String
name		String!

OrganizationList

Field	Argument	Type	Description
items		[Organization!]!
totalItems		Int!

OrganizationSignInInfo

Field	Argument	Type	Description
id		ID!
profilePictureUrl		String
name		String!
languageId		String!
subDomain		String!
hexColor		String
authentication		AuthenticationMethodsByOrganization!
requisitionSharedLinkEnabledStatus		Boolean!
contractFormId		String
requisitionFormId		String
contractFormProvider		String!
requisitionFormProvider		String!

Requisition

Field	Type	Description
id	ID!
typeformFormId	String
statusCategoryId	RequisitionStatusCategoryEnum!
statusDataId	ID!	This field is temporary and will be renamed to `statusId`.
statusData	RequisitionStatus!	This field is temporary and will be renamed to `status`.
requester	User!
assignee ⚠️	User	⚠️ DEPRECATED A requisition can have many assignees, use the `assignees` field
assignees	[User]
finishedBy	User
createdAt	DateTime
customFields	[CustomField!]!
updatedAt	DateTime
form	Form
participants	[User!]
isFormAnswered	Boolean!
timeSpentToFinish	Float
slaDate	DateTime
slaStatus	RequisitionSlaStatusEnum!
contractSlug	String
fillFieldsByAIStatus	FillFieldsByAIStatus
lastActivityAt	DateTime
hasUpdates	Boolean

RequisitionBatchUpdateAssigneesResult

Field	Argument	Type	Description
assigneesAdded		Int!
assigneesRemoved		Int!
affectedRequisitions		Int!
assigneesIgnored		Int!
affectedRequisitionIds		[ID!]!
warnings		[RequisitionBatchWarning!]!
invalidUserIds		[ID!]!

RequisitionBatchUpdateStatusResult

Field	Argument	Type	Description
statusUpdated		Int!
requisitionsFinished		Int!
affectedRequisitions		Int!
skippedRequisitions		Int!
affectedRequisitionIds		[ID!]!
warnings		[RequisitionBatchWarning!]!

RequisitionBatchWarning

Field	Argument	Type	Description
code		String!
message		String!
requisitionIds		[ID!]

RequisitionCustomFieldSearchResult

Field	Argument	Type	Description
id		ID!
type		String!
highlight		RequisitionCustomFieldSearchResultHighlight
label		String
value		String
customFieldType		String
requisitionId		ID!
origin		String
createdAt		DateTime!
updatedAt		DateTime!

RequisitionCustomFieldSearchResultHighlight

Field	Argument	Type	Description
value		[String]!

RequisitionCustomFieldVisibility

Field	Argument	Type	Description
id		ID!
label		String!

RequisitionDeleted

Field	Argument	Type	Description
id		ID!
isDisabled		Boolean

RequisitionFile

Field	Argument	Type	Description
attachedBy		RequisitionFileAttachedByEnum!
createdAt		DateTime!
fileDownloadUrl		String!
fileExtension		String!
fileName		String!
id		ID!
messageId		ID
requisitionId		ID!
requisitionChatGroupId		ID
sender		User!
sfdt		JSON!
size		Int!
version		Int
latestVersion		RequisitionFile
metaId		ID
signed		Boolean!
automaticallyAssigned		Boolean!

RequisitionFileList

Field	Argument	Type	Description
items		[RequisitionFile!]!	Arquivos retornados
totalItems		Int!	Número total de arquivos que foram encontradas, sem considerar o limit

RequisitionFileSearchResult

Field	Argument	Type	Description
id		ID!
type		String!
highlight		RequisitionFileSearchResultHighlight
fileName		String!
fileExtension		String!
size		Int!
sender		User!
senderId		String!
requisitionId		ID!
createdAt		DateTime!
updatedAt		DateTime!

RequisitionFileSearchResultHighlight

Field	Argument	Type	Description
fileName		[String]!

RequisitionFormResponseSearchResult

Field	Argument	Type	Description
id		ID!
type		String!
highlight		RequisitionFormResponseSearchResultHighlight!
answerText		String
questionType		String
questionTitle		String
requisitionId		ID!
createdAt		DateTime!
updatedAt		DateTime!

RequisitionFormResponseSearchResultHighlight

Field	Argument	Type	Description
answerText		[String]
questionTitle		[String]

RequisitionList

Field	Argument	Type	Description
items		[Requisition!]!	Demandas retornadas
totalItems		Int!	Número total de demandas que foram encontradas, sem considerar o take

RequisitionMessage

Field	Argument	Type	Description
id		ID!
content		String
sender		User!
requisitionId		ID!
requisitionChatGroupId		ID
files		[RequisitionFile]!
createdAt		DateTime!

RequisitionMessageSearchResult

Field	Argument	Type	Description
id		ID!
type		String!
highlight		RequisitionMessageSearchResultHighlight
content		String
sender		User!
senderId		String!
requisitionId		ID!
createdAt		DateTime!
updatedAt		DateTime!

RequisitionMessageSearchResultHighlight

Field	Argument	Type	Description
content		[String]!

RequisitionResumeResult

Field	Argument	Type	Description
created		Resume!
finishedOnTime		Resume!
finishedLate		Resume!
averageCompletionTime		Resume!

RequisitionStatus

Field	Argument	Type	Description
id		ID!
label		String!
category		RequisitionStatusCategory!
isDefault		Boolean!
isDisabled		Boolean!
isInitial		Boolean!
createdAt		DateTime!
updatedAt		DateTime!
requisitionsCount		Int!
organizationForm		OrganizationForm

RequisitionStatusCategory

Field	Argument	Type	Description
id		RequisitionStatusCategoryEnum!
hexColor		String!
isCustomizable		Boolean!

Requisition_exportReportOutput

Field	Argument	Type	Description
downloadUrl		String!

RequisitionsCount

Field	Argument	Type	Description
labels		[String]!
data		[Int]!

RequisitionsOverviewChartResult

Field	Argument	Type	Description
date		Date
values		RequisitionsOverviewChartValues

RequisitionsOverviewChartResultList

Field	Argument	Type	Description
items		[RequisitionsOverviewChartResult!]!
totalItems		Int!

RequisitionsOverviewChartValues

Field	Argument	Type	Description
OPEN		Int!
FINISHED		Int!

RequisitionsSlaOverviewStatusResult

Field	Argument	Type	Description
EMPTY		Int!
IN_PROGRESS		Int!
OVERDUE		Int!
ALMOST_OVERDUE		Int!

RequisitionsSlaStatusByAssigneeResult

Field	Argument	Type	Description
user		User!
OVERDUE		Int!
ALMOST_OVERDUE		Int!
IN_PROGRESS		Int!
EMPTY		Int!
total		Int!

RequisitionsSlaStatusByAssigneeResultList

Field	Argument	Type	Description
items		[RequisitionsSlaStatusByAssigneeResult!]!
totalItems		Int!

Resume

Field	Argument	Type	Description
currentCount		Int!
pastCount		Int!

Schema

Field	Argument	Type	Description
query		Query
mutation		Mutation
subscription		Subscription

SearchCount

Field	Argument	Type	Description
totalItems		Int!
totalRequisitionMessage		Int!
totalRequisitionFile		Int!
totalRequisitionCustomField		Int!

SearchResult

Field	Argument	Type	Description
count		SearchCount!
items		[SearchResultItems]!

SignInResponse

Token de autorização

Field	Argument	Type	Description
jwtToken		String!

SignUpResponse

Resposta do Sign Up do usuário

Field	Argument	Type	Description
user		User!
jwtToken		String!

Sla

Field	Argument	Type	Description
qtyDays		Int!
daysType		SlaRuleEnum!

SubscriptionRequisitionFilesResponse

Field	Argument	Type	Description
operation		RequisitionFilesOperation!
files		[RequisitionFile!]!

SubscriptionRequisitionMessageResponse

Field	Argument	Type	Description
operation		RequisitionMessageOperation!
message		RequisitionMessage
file		RequisitionFile

SuccessResponse

Campo utilizado como resposta de operações que retonam apenas um boolean de sucesso

Field	Argument	Type	Description
success		Boolean!

UpdatedAutomation

Field	Argument	Type	Description
id		String!
label		String!

UpdatedCustomField

Field	Argument	Type	Description
id		String!
requisitionId		String!
customFieldLabel		String!
customFieldValue		String!
previousValue		String

User

Representa um usuário de uma organização

Field	Argument	Type	Description
id		ID!
name		String
area		String
email		String
profilePictureUrl		String
isRegistrationPending		Boolean
languageId		String
organization		Organization
jobTitle		String
hexColor		String
phoneNumber		String
roleId		String
customRole		CustomRole
isDisabled		Boolean
createdAt		DateTime
updatedAt		DateTime
hasAllowedLogin		Boolean

UserEventItem

User event item

Field	Argument	Type	Description
id		ID!
eventName		String!
occurredAt		DateTime!
affectedUser		AffectedUser!
actor		EventActor!

UserGroup

Represents a user group within an organization. Groups can be used to assign multiple users as participants in contracts.

Field	Type	Description
id	ID!
name	String!
description	String
organizationId	ID!
membersCount	Int	Number of members in the group. Null if members relation was not loaded.
createdAt	DateTime!
updatedAt	DateTime!

UserList

Lista paginada de usuários

Field	Argument	Type	Description
items		[User!]!	Usuários retornados
totalItems		Int!	Número total de usuários que foram encontrados, sem considerar o take

User_ListEvents_Output

Output for listing user events

Field	Argument	Type	Description
events		[UserEventItem!]!
total		Int!

ValidationIssue

Field	Argument	Type	Description
automationId		ID!
automationLabel		String!
conditionId		ID!
issueType		ValidationIssueType!
reference		String
value		String
message		String!

ValidationResult

Field	Argument	Type	Description
organizationId		ID!
totalAutomations		Int!
validAutomations		Int!
invalidAutomations		Int!
issues		[ValidationIssue!]!

Inputs

AIChatInput

Field		Type	Description
message		String!
threadId		String
assistantId		String!
files		[Upload!]

AI_FaqInput

Field		Type	Description
message		String!
threadId		String

ArrayOperators

Operações de comparações em Array

Field		Type	Description
in		[String]	Busca uma String que esteja entre os valores passados.

AutomationSlaInput

Field		Type	Description
slaDays		Int!
slaRule		SlaRuleEnum!

BooleanOperators

Operações para Booleans

Field		Type	Description
eq		Boolean

ChangeUserPasswordInput

Input for changing user password

Field		Type	Description
newPassword		String!

ChangeUserRoleInput

Input for changing user role

Field		Type	Description
roleId		RoleEnum
customRoleId		ID
userId		ID!

ConditionCreateInput

Field		Type	Description
label		String!
ast		JSON!

ContractAttachmentSortParameter

Fields in which [ContractFile!]! can be sorted on

Field		Type	Description
createdAt		SortOrder
fileName		SortOrder

ContractAttachmentsListInput

Field		Type	Description
contractId		ID!
sort		ContractAttachmentSortParameter

ContractListFilterCondition

Field		Type	Description
isCustomField		Boolean!
property		String!
comparator		ContractListFilterComparatorEnum!
value		JSON

ContractListFilterOptions

Field		Type	Description
conditions		[ContractListFilterCondition!]!
logicOperator		ContractListFilterLogicOperatorEnum!

ContractListInput

Field		Type	Description
take		Int
skip		Int
sort		ContractListSortOption
filter		ContractListFilterOptions

ContractListSortOption

Field		Type	Description
createdAt		SortOrder
effectiveDate		SortOrder
expirationDate		SortOrder
participantName		SortOrder
requestingArea		SortOrder
slug		SortOrder
statusCategory		SortOrder
statusLabel		SortOrder
type		SortOrder
value		SortOrder
kind		SortOrder

ContractQuickSearchInput

Field		Type	Description
take		Int
skip		Int
term		String

ContractStatusCreateInput

Field		Type	Description
label		String!
category		ContractStatusCategoryCreatableEnum!

ContractStatusDeleteInput

Field		Type	Description
toBeDeletedId		ID!
replacementId		ID!

ContractStatusSetDefaultInput

Field		Type	Description
id		ID!

ContractStatusUpdateInput

Field		Type	Description
id		ID!
label		String!

ContractUpsertCustomFieldChildInput

Field		Type	Description
id		String!
label		String!
type		CustomFieldChildTypeEnum!
value		String!

ContractUpsertCustomFieldInput

Field		Type	Description
id		String!
contractId		String!
label		String!
type		CustomFieldTypeEnum!
value		String!
children		[ContractUpsertCustomFieldChildInput!]

CreateOCRTemplateFieldsInput

Field		Type	Description
name		String!
fields		JSON!

CustomFieldChildInput

Field		Type	Description
label		String!
type		CustomFieldChildTypeEnum!
value		String!

CustomFieldInput

Field		Type	Description
label		String!
type		CustomFieldTypeEnum!
value		String!
children		[CustomFieldChildInput!]

DashboardInput

Field		Type	Description
filter		DashboardRange!

DashboardRange

Field		Type	Description
range		DateRange!

DateOperators

Operações de comparaçoes para Dates

Field	Type	Description
eq	DateTime	Busca um Date igual ao valor passado
before	DateTime	Busca um Date antes do valor passado
after	DateTime	Busca um Date após o valor passado
between	DateRange	Busca um Date entre os valores passados

DateRange

Field		Type	Description
start		DateTime!
end		DateTime!

EditBasicFieldsInput

Field		Type	Description
contractId		ID!
value		Float
currency		ContractCurrencyEnum!
effectiveDate		DateTime
expirationDate		DateTime
type		String
requestingArea		String
statusId		ID!

EffectInitRequisitionCreateInput

Field		Type	Description
label		String!
assigneeId		ID
docxFileTemplateIds		[ID!]
assigneeIds		[ID!]
participantsId		[ID!]!
conditionId		ID!
sla		SlaConfigInput
statusId		ID
assigneeType		AssigneeTypeEnum

EffectInitRequisitionDeleteInput

Field		Type	Description
id		ID!

EffectInitRequisitionDuplicateInput

Field		Type	Description
id		ID!

EffectInitRequisitionListReorderInput

Field		Type	Description
effects		[PrioritizedEffectID!]!

EffectInitRequisitionList_Input

Field		Type	Description
searchTerm		String

EffectInitRequisitionUpdateInput

Field		Type	Description
id		ID!
label		String!
assigneeId		ID
docxFileTemplateIds		[ID!]!
assigneeIds		[ID!]
participantsId		[ID!]!
conditionId		ID!
sla		SlaConfigInput
statusId		ID
assigneeType		AssigneeTypeEnum

EffectInitRequisition_Input

Field		Type	Description
id		String!

EffectRequisitionAutomationListFromStatusReorderInput

Field		Type	Description
effects		[PrioritizedEffectID!]!
fromStatusId		ID!

EffectRequisitionAutomationListReorderInput

Field		Type	Description
effects		[PrioritizedEffectID!]!

EffectRequisitionAutomationUpdateInput

Field		Type	Description
id		ID!
label		String!
assigneeId		ID
assigneeIds		[ID!]
externalAssigneeEmail		String
customFieldEmailLabel		String
conditionId		ID!
statusId		ID
fromStatusId		ID
assigneeType		EffectRequisitionAutomationAssigneeType!
sla		AutomationSlaInput
triggerType		EffectRequisitionAutomationTriggerType

FixAutomationReferencesInput

Field		Type	Description
fixes		[ReferenceFix!]!
dryRun		Boolean	Simulate changes without applying

HasOrganizationInput

Field		Type	Description
registrationNumber		String!

ImportContractsInput

Field		Type	Description
sheet		Upload!
zipFile		Upload

InviteUserInput

Field		Type	Description
emails		[String!]!
roleId		RoleEnum!
customRoleId		ID

ListInboxEmailsOptions

Field		Type	Description
pageToken		String
take		Int

OrganizationFilterParameter

Field		Type	Description
name		StringOperators
registrationNumber		StringOperators
subDomain		StringOperators
isDisabled		BooleanOperators
createdAt		DateOperators
languageId		StringOperators

OrganizationListOptions

Field	Type	Description
take	Int	How many items to list. Defaults to 10.
skip	Int	How many items to be skipped (from the start). Defaults to 0.
sort	OrganizationSortParameter
filter	OrganizationFilterParameter

OrganizationSortParameter

Field		Type	Description
id		SortOrder
name		SortOrder
registrationNumber		SortOrder
subDomain		SortOrder
createdAt		SortOrder
languageId		SortOrder

Organization_SetContractRemindersEnabledStatusOnOrganization_Input

Field		Type	Description
enable		Boolean!

Organization_createContractRenewalReminder_Input

Field		Type	Description
name		String!
timer		Int!

Organization_deleteContractRenewalReminder_Input

Field		Type	Description
id		ID!

Organization_setRequisitionSharedLinkEnabledStatus_Input

Field		Type	Description
enable		Boolean!

Organization_updateContractRenewReminder_Input

Field		Type	Description
id		ID!
name		String!
timer		Int!

Organization_upsertDefaultContractView_Input

Field		Type	Description
defaultContractView		JSON!

Organization_upsertDefaultRequisitionView_Input

Field		Type	Description
defaultRequisitionView		JSON!

PrioritizedEffectID

Field		Type	Description
id		ID!
priority		Int!

ReferenceFix

Field	Type	Description
oldReference	String!
newReference	String	New reference to replace with (required for MISSING_REFERENCE)
issueType	ValidationIssueType!
valueMappings	[ValueMapping!]	Value mappings (required for INVALID_VALUE)

ReplaceContractFileInput

Field		Type	Description
contractId		ID!
file		Upload!

RequisitionAddAssigneeInput

Field		Type	Description
requisitionId		ID!
assigneeId		ID!

RequisitionAddParticipantsInput

Field		Type	Description
requisitionId		ID!
userIds		[ID!]!

RequisitionBatchAssigneeOperationsInput

Field		Type	Description
addUserIds		[ID!]
removeUserIds		[ID!]

RequisitionBatchScopeInput

Field		Type	Description
type		RequisitionBatchScopeTypeEnum!
ids		[ID!]
filter		RequisitionListFilterOptions

RequisitionBatchStatusScopeInput

Field		Type	Description
type		RequisitionBatchStatusScopeTypeEnum!
ids		[ID!]
filter		RequisitionListFilterOptions

RequisitionBatchUpdateAssigneesInput

Field		Type	Description
scope		RequisitionBatchScopeInput!
operations		RequisitionBatchAssigneeOperationsInput!

RequisitionBatchUpdateParticipantsInput

Field		Type	Description
requisitionIds		[ID!]!
addedParticipantIds		[ID!]
removedParticipantIds		[ID!]

RequisitionBatchUpdateStatusInput

Field		Type	Description
scope		RequisitionBatchStatusScopeInput!
statusId		ID!

RequisitionFieldInput

Field		Type	Description
label		String!
type		AnswerType!
value		String!
originRefId		String

RequisitionFileFilter

Field		Type	Description
senderId		ID
createdAt		DateOperators
fileExtension		String

RequisitionFileInput

Field		Type	Description
requisitionFileId		ID!
requisitionId		String!

RequisitionFileSortParameter

Fields in which [RequisitionFile!]! can be sorted on

Field		Type	Description
createdAt		SortOrder
fileName		SortOrder

RequisitionFileVersionsInput

Field		Type	Description
requisitionId		ID!
requisitionFileId		ID
requisitionFileMetaId		ID

RequisitionFile_compareFiles_Input

Field		Type	Description
fileSourceId		ID!
fileTargetId		ID!
requisitionId		ID!

RequisitionFile_saveNewVersion_Input

Field		Type	Description
metaId		ID!
requisitionId		ID!
file		Upload!
messageText		String

RequisitionFilesListInput

Field		Type	Description
requisitionId		ID!
sort		RequisitionFileSortParameter

RequisitionFilter

Field		Type	Description
id		ID
status		[RequisitionStatusCategoryEnum!]
statusDataId		[ID!]
assigneeId		ID
requesterId		ID
createdAt		DateOperators
slaDate		DateTime

RequisitionFilterParameter

Campos filtráveis da demanda

Field	Type	Description
id	StringOperators
requesterId	StringOperators
assigneeId	StringOperators
finishedById	StringOperators
statusCategoryId	ArrayOperators
status	ArrayOperators	Deprecated. Use `statusCategoryId` instead.
statusDataId	ArrayOperators	As soon as `status` is removed, this field will be renamed to `statusDataId`
slaStatus	ArrayOperators
participants	ArrayOperators
createdAt	DateOperators
updatedAt	DateOperators

RequisitionFinishInput

Field		Type	Description
requisitionId		ID!
timeSpent		Float

RequisitionListFilterCondition

Field		Type	Description
isCustomField		Boolean!
property		String!
comparator		RequisitionListFilterComparatorEnum!
value		String!

RequisitionListFilterOptions

Field		Type	Description
logicOperator		RequisitionListFilterLogicOperatorEnum!
conditions		[RequisitionListFilterCondition!]!

RequisitionListInput

Field		Type	Description
take		Int
skip		Int
sort		RequisitionListSortOptions
filter		RequisitionListFilterOptions

RequisitionListOptions

Opções de busca de usuários

Field	Type	Description
take	Int	Quantos itens devem ser retornados, padrão 10
skip	Int	Quantos itens devem ser pulados na busca
sort	RequisitionSortParameter
filter	RequisitionFilterParameter

RequisitionListSortOptions

Field		Type	Description
createdAt		SortOrder
id		SortOrder
slaDate		SortOrder
statusLabel		SortOrder
lastActivityAt		SortOrder

RequisitionMessageFilter

Field		Type	Description
senderId		ID
createdAt		DateOperators

RequisitionMessageSendExternalInput

Field		Type	Description
requisitionId		ID!
messageText		String!
guestsEmails		[String!]!
files		[Upload!]

RequisitionRemoveAssigneeInput

Field		Type	Description
requisitionId		ID!
assigneeId		ID!

RequisitionRemoveParticipantInput

Field		Type	Description
requisitionId		ID!
userId		ID!

RequisitionSortParameter

Campos ordenáveis da demanda

Field	Type	Description
id	SortOrder
status	SortOrder	Deprecated. Use `statusCategoryId` instead.
statusDataId	SortOrder
createdAt	SortOrder
updatedAt	SortOrder
slaDate	SortOrder

RequisitionStatusCreateInput

Field		Type	Description
label		String!
categoryId		RequisitionStatusCategoryEnum!

RequisitionStatusDeleteInput

Field		Type	Description
toBeDeletedId		ID!
replacementId		ID!

RequisitionStatusSetDefaultInput

Field		Type	Description
id		ID!

RequisitionStatusUpdateInput

Field		Type	Description
id		ID!
label		String!
categoryId		RequisitionStatusCategoryEnum!

RequisitionUpdateSLAInput

Field		Type	Description
requisitionId		ID!
slaDate		DateTime

RequisitionUpdateStatusInput

Field		Type	Description
requisitionId		ID!
statusId		ID!
assigneeId		ID

RequisitionUpsertCustomFieldChildInput

Field		Type	Description
id		String!
label		String!
type		CustomFieldChildTypeEnum!
value		String!
originRefId		String

Requisition_CreateFullRequisition_File_Input

Field		Type	Description
base64		String!
fileName		String!
fileExtension		String!

Requisition_DeleteCustomField_Input

Field		Type	Description
customFieldId		String!
requisitionId		String!

Requisition_UpsertCustomField_Input

Field		Type	Description
id		String!
requisitionId		String!
label		String!
type		RequisitionCustomFieldTypeEnum!
value		String!
originRefId		String
children		[RequisitionUpsertCustomFieldChildInput!]

Requisition_changeRequester_Input

Field		Type	Description
requisitionId		ID!
newRequesterId		ID!

Requisition_createFullRequisition_Input

Field	Type	Description
email	String
requesterRoleId	RequesterRoleEnum
assigneeEmail	String
fields	[RequisitionFieldInput!]
files	[Requisition_CreateFullRequisition_File_Input!]
organizationId	ID	Deprecated. this field is optional, if not informed API can get organizationId from current token

Requisition_createRequisitionFromDocs_input

Field		Type	Description
organizationId		String
email		String
requisitionId		String
docsResponseId		String!
originalResponses		JSON
variables		JSON

Requisition_createRequisitionFromSharedLink_Input

Field		Type	Description
organizationId		ID!
email		String!
typeformResponseId		String!

Requisition_fillDocsFormFromSharedLink_Input

Field		Type	Description
organizationId		String!
requisitionId		String!
email		String!
docsResponseId		String!
originalResponses		JSON

Requisition_fillDocsForm_input

Field		Type	Description
requisitionId		String!
docsResponseId		String!
originalResponses		JSON
variables		JSON

Requisition_importFromNetlex_Input

Field		Type	Description
domain		String!
listToken		String!
documentToken		String!
attachmentToken		String!
templateId		String
batchSize		Int
startPage		Int
endPage		Int

Requisition_refreshSharedLinkToken_Input

Field		Type	Description
token		String!

Requisition_refreshToken_Input

Field		Type	Description
token		String!

Requisition_restoreRequisition_Input

Field		Type	Description
requisitionId		ID!

RequisitionsCountOptions

Field		Type	Description
countRequisitionsBy		RequisitionsCountEnum!
dateBetweenUtc		DateRange!
utcOffset		Int!

RequisitionsSlaSatusByAssigneeFilter

Field		Type	Description
assigneeIds		ArrayOperators

RequisitionsSlaStatusByAssigneeOptions

Field		Type	Description
take		Int!
skip		Int!
filter		RequisitionsSlaSatusByAssigneeFilter

Field		Type	Description
query		String!
type		SearchType!
requisition		RequisitionFilter
requisitionMessage		RequisitionMessageFilter
requisitionFile		RequisitionFileFilter

SearchInput

Field		Type	Description
take		Int
skip		Int
sort		SearchSortParameter
filter		SearchFilter!

SearchSortParameter

Campos ordenáveis da busca avançada

Field		Type	Description
createdAt		SortOrder
updatedAt		SortOrder

SendRequisitionChatGroupMessageWithFilesInput

Field		Type	Description
requisitionId		ID!
files		[Upload!]
requisitionFileId		ID
messageText		String
requisitionChatGroupId		ID!

SendRequisitionMessageWithFilesInput

Field		Type	Description
requisitionId		ID!
files		[Upload!]
requisitionFileId		ID
messageText		String

SignInInput

Field		Type	Description
organizationId		ID!
email		String!
password		String!

SignUpInput

Field		Type	Description
inviteToken		String!
name		String!
area		String!
password		String!
timezoneOffset		Int

SlaConfigInput

Field		Type	Description
qtyDays		Int!
daysType		SlaRuleEnum!

StringContainsOperators

Operação de comparação para String

Field		Type	Description
contains		String	Busca uma String que contenha o valor passado. Para usar like utilize % antes e/ou depois da String

StringOperators

Operações de comparações para Strings

Field	Type	Description
eq	String	Busca uma String igual ao valor passado
contains	String	Busca uma String case-insensitive que contenha o valor passado. Para usar like utilize % antes e/ou depois da String
containsSensitive	String	Busca uma String case-sensitive que contenha o valor passado. Para usar like utilize % antes e/ou depois da String

UpdateOCRTemplateFieldsInput

Field		Type	Description
name		String!
fields		JSON!

UpdateOrganizationBasicInfoInput

Field		Type	Description
name		String
registrationNumber		String
prefix		String
areas		[String!]
languageId		LanguageEnum
SLA		Int
slaRule		SlaRuleEnum
requisitionWithoutForm		Boolean
highlightedLabel		String
subjectAsHighlightedLabel		Boolean
ssoDefaultCustomRoleId		String
metadata		JSON

UpdateOrganizationUserBasicInfoInput

Input for organization admins to update another user's basic info

Field		Type	Description
userId		ID!
name		String
area		String
jobTitle		String
phoneNumber		String
languageId		LanguageEnum

UpdateUserBasicInfoInput

Input for updating user basic info

Field		Type	Description
name		String
area		String
jobTitle		String
phoneNumber		String
languageId		LanguageEnum

UploadContractAttachmentsInput

Field		Type	Description
contractId		ID!
attachments		[Upload!]!

UploadOrganizationAvatarInput

Field		Type	Description
image		Upload!

UploadRequisitionFilesInput

Field		Type	Description
requisitionId		ID!
files		[Upload!]
filesBase64		[UploadRequisitionFiles_Base64_Input!]

UploadRequisitionFiles_Base64_Input

Field		Type	Description
base64		String!
fileName		String!
fileExtension		String!

UploadUserAvatarInput

Input for updating user avatar image

Field		Type	Description
image		Upload!

UserFilterParameter

User filterable fields

Field		Type	Description
id		ArrayOperators
name		StringOperators
area		StringOperators
email		StringOperators
isRegistrationPending		Boolean
createdAt		DateOperators

UserListOptions

Opções de busca de usuários

Field	Type	Description
take	Int	Quantos itens devem ser retornados, padrão 10
skip	Int	Quantos itens devem ser pulados na busca
sort	UserSortParameter
filter	UserFilterParameter

UserSortParameter

Campos ordenáveis do usuário

Field		Type	Description
id		SortOrder
name		SortOrder
email		SortOrder
area		SortOrder
createdAt		SortOrder
updatedAt		SortOrder

User_ListEvents_Input

Input for listing user events

Field		Type	Description
startDate		Date!
endDate		Date!
eventType		UserEventTypeEnum!

ValueMapping

Field		Type	Description
oldValue		String!
newValue		String!

changePasswordWithTokenInput

Field		Type	Description
recoverPasswordToken		String!
newPassword		String!

deleteRequisitionAutomationInput

Field		Type	Description
id		ID!

deleteRequisitionChatGroupFileInput

Field		Type	Description
requisitionFileId		ID!
requisitionChatGroupId		ID!

Enums

AnswerType

Value	Description
choice
choices
date
email
url
file_url
number
boolean
text
phone_number

AssigneeTypeEnum

Value	Description
ASSIGNEE_ID
REQUISITION_CREATOR

AuthorizationEnum

Value	Description
SAML
PASSWORD

ContractCurrencyEnum

Value	Description
BRL
USD
EUR
JPY
GBP
CAD
AUD
CHF
CNY
HKD
SGD
MXN

ContractFileTypeEnum

Value	Description
CONTRACT
ATTACHMENT

ContractKindEnum

Value	Description
PRINCIPAL
AMENDMENT

ContractListFilterComparatorEnum

Value	Description
CONTAINS
EQUALS
GREATER_OR_EQUALS
LESS_OR_EQUALS
BETWEEN

ContractListFilterLogicOperatorEnum

Value	Description
AND
OR

ContractParticipantRoleEnum

Value	Description
CONTRACT_FULL_USER
CONTRACT_MANAGER
CONTRACT_RECIPIENT
CONTRACT_VIEWER

ContractStatusCategoryCreatableEnum

Value	Description
ACTIVE

ContractStatusCategoryEnum

Value	Description
ACTIVE
FINISHED

CustomFieldChildTypeEnum

Value	Description
BOOLEAN
TEXT
NUMBER
DATE

CustomFieldTypeEnum

Value	Description
BOOLEAN
TEXT
NUMBER
DATE
COUNTERPART
PARENT

EffectRequisitionAutomationAssigneeType

Value	Description
ASSIGNEE_ID
REQUISITION_CREATOR
EXTERNAL
CUSTOM_FIELD_EMAIL

EffectRequisitionAutomationTriggerType

Value	Description
SIGNATURE_COMPLETED
FORM_FILLED

EffectTypeEnum

Value	Description
INIT_REQUISITION

FillFieldsByAIStatus

Value	Description
ERROR
PROCESSING
FINISHED

FormProvider

Value	Description
TYPEFORM
DOCS

FormQuestionTypeEnum

Value	Description
date
dropdown
email
file_upload
group
legal
long_text
multiple_choice
number
opinion_scale
payment
phone_number
picture_choice
rating
short_text
statement
website
yes_no

LabelIdsEnum

Value	Description
UNREAD
INBOX

LanguageEnum

Value	Description
PT_BR
EN_US
ES_ES

OAuthCheckStatusEnum

Value	Description
OAUTH_AUTHORIZED
OAUTH_NOT_AUTHORIZED
OAUTH_PENDING_AUTHORIZATION

RequesterRoleEnum

Value	Description
ORGANIZATION_MEMBER
ORGANIZATION_GUEST

RequisitionBatchScopeTypeEnum

Value	Description
SELECTION
FILTER
ALL

RequisitionBatchStatusScopeTypeEnum

Value	Description
SELECTION
FILTER

RequisitionCustomFieldTypeEnum

Value	Description
BOOLEAN
DATE
NUMBER
TEXT
PARENT

RequisitionFileAttachedByEnum

Value	Description
INTERNAL
EMAIL
SLACK

RequisitionFilesOperation

Enum para listar as operações possíveis no subscription 'requisitionFile'

Value	Description
INSERT_FILES
DELETE_FILES

RequisitionListFilterComparatorEnum

Value	Description
CONTAINS
EQUALS
GREATER_THAN_OR_EQUAL
LESS_THAN_OR_EQUAL

RequisitionListFilterLogicOperatorEnum

Value	Description
AND
OR

RequisitionMessageOperation

Enum para listar as operações possíveis no subscription 'requisitionMessage'

Value	Description
INSERT_MESSAGE
DELETE_MESSAGE
DELETE_FILE_IN_MESSAGE

RequisitionSlaStatusEnum

Value	Description
EMPTY
IN_PROGRESS
OVERDUE
ALMOST_OVERDUE

RequisitionStatusCategoryCreatableEnum

Value	Description
OPEN

RequisitionStatusCategoryEnum

Value	Description
OPEN
REQUESTER
LEGAL
APPROVERS
COUNTERPART
SIGNER
FINISHED

RequisitionsCountEnum

Value	Description
CREATED_REQUISITIONS
CLOSED_REQUISITIONS

Role

Value	Description
ORGANIZATION_ADMIN
ORGANIZATION_MEMBER
ORGANIZATION_GUEST

RoleEnum

Value	Description
ORGANIZATION_ADMIN
ORGANIZATION_MEMBER
ORGANIZATION_GUEST

SearchType

Value	Description
ALL
REQUISITION_FILES
REQUISITION_MESSAGES
REQUISITION_CUSTOM_FIELDS

SlaRuleEnum

Value	Description
RUNNING_DAYS
WORKING_DAYS

SortOrder

Value	Description
ASC
DESC

TermStatusEnum

Value	Description
UNDETERMINED
IN_EFFECT
WILL_BE_OUT_OF_EFFECT_SOON
OUT_OF_EFFECT

UserEventTypeEnum

Available user event types

Value	Description
USER_WAS_CREATED
USER_WAS_UPDATED
USER_WAS_DELETED
USER_WAS_LOGGED_IN

ValidationIssueType

Value	Description
MISSING_REFERENCE
INVALID_VALUE
MISSING_VALUE

Scalars

Boolean

The Boolean scalar type represents true or false.

Date

DateTime

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSON

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Upload

The Upload scalar type represents a file upload.

Interfaces

Effect

Field	Argument	Type	Description
id		ID!
label		String!
condition		Condition
organization		Organization!
creator		User!
createdAt		DateTime!
updatedAt		DateTime!

Possible Types: EffectInitRequisition

Node

Um node no GraphqQL

Field	Argument	Type	Description
id		ID!

Possible Types: User

PaginationList

Lista paginada de Nodes

Field	Argument	Type	Description
items		[Node!]!	Itens retornados
totalItems		Int!	Número total de itens que foram encontrados, sem considerar o take

Possible Types: UserList

Unions

RequisitionSubscription

Type	Description
Requisition
RequisitionDeleted

SearchResultItems

Type	Description
RequisitionFileSearchResult
RequisitionMessageSearchResult
RequisitionCustomFieldSearchResult

API ​

Query ​

Mutation ​

Subscription ​

Objects ​

AIChatOutput ​

AI_FaqOutput ​

AffectedAutomation ​

AffectedAutomationReference ​

AffectedField ​

AffectedRequisition ​

AffectedRequisitionReference ​

AffectedUser ​

Authentication ​

AuthenticationMethodsByOrganization ​

AuthenticationOrganization ​

AuthorizationOAuthGetUrlResponse ​

AutomationImpactAnalysis ​

AutomationIssue ​

BrokenReference ​

ChangePasswordWithTokenResponse ​

Condition ​

Contract ​

ContractFile ​

ContractList ​

ContractParticipant ​

ContractRenewalReminder ​

ContractStatus ​

Contract_importContracts_Output ​

CreateRequisitionResponse ​

CustomField ​

CustomFieldChild ​

CustomFieldLabelWithContractCount ​

CustomFieldLabelWithRequisitionCount ​

CustomFieldReference ​

CustomRole ​

CustomRolePermission ​

Dashboard_ContractsTermStatusOverview_Output ​

Dashboard_GetMetabaseUrls_Output ​

Deletion ​

DocsForm ​

DocxFileTemplate ​

DocxFileTemplateVersion ​

EffectInitRequisition ​

EffectInitRequisitionList_Output ​

EffectRequisitionAutomation ​

Email ​

EmailSender ​

EventActor ​

FixAutomationReferencesResult ​

FixError ​

FixSummary ​

Form ​

FormQuestion ​

FormQuestionChoices ​

FormQuestionProperties ​

GetSignInInfoResponse ​

ImpactSummary ​

Language ​

ListContractAttachmentsResponse ​

ListInboxEmailResponse ​

NetlexMigrationResult ​

NetlexRequisitionCreated ​

OAuthCheckStatusResponse ​

OCRTemplateFields ​

Organization ​

OrganizationContractType ​

OrganizationForm ​

OrganizationList ​

OrganizationSignInInfo ​

Requisition ​

RequisitionBatchUpdateAssigneesResult ​

RequisitionBatchUpdateStatusResult ​

RequisitionBatchWarning ​

RequisitionCustomFieldSearchResult ​

RequisitionCustomFieldSearchResultHighlight ​

RequisitionCustomFieldVisibility ​

RequisitionDeleted ​

RequisitionFile ​

RequisitionFileList ​

API