GraphQL Mutations

Complete list of all 92 mutations available in the API.

All mutations require authentication and will modify data in your organization.

accountCreate

accountCreate(
  input: AccountCreateInput!
): AccountCreatePayload

Input: AccountCreateInput

Show fields

Parameters for AccountCreate

Field	Type	Description
accountNumber	`String`
accountType required	`String`!
bankId	`ModelId`
blockchain	`String`
branchNumber	`String`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
currency	`String`
description	`String`
initialBalance	`Float`
name required	`String`!
network	`String`
status	`String`
walletAddress	`String`

Returns: AccountCreatePayload

Show fields

Autogenerated return type of AccountCreate.

Field	Type	Description
account	`Account`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

accountDelete

accountDelete(
  input: AccountDeleteInput!
): AccountDeletePayload

Input: AccountDeleteInput

Show fields

Parameters for AccountDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: AccountDeletePayload

Show fields

Autogenerated return type of AccountDelete.

Field	Type	Description
account	`Account`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

accountUpdate

accountUpdate(
  input: AccountUpdateInput!
): AccountUpdatePayload

Input: AccountUpdateInput

Show fields

Parameters for AccountUpdate

Field	Type	Description
accountType	`String`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
currency	`String`
description	`String`
initialBalance	`Float`
name	`String`
status	`String`

Returns: AccountUpdatePayload

Show fields

Autogenerated return type of AccountUpdate.

Field	Type	Description
account	`Account`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

accountsPayableCreate

accountsPayableCreate(
  input: AccountsPayableCreateInput!
): AccountsPayableCreatePayload

Input: AccountsPayableCreateInput

Show fields

Parameters for AccountsPayableCreate

Field	Type	Description
allocationsAttributes required	[`AllocationInput`!]
categoryId required	`ModelId`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.
currency required	`String`!
dueDate required	`ISO8601DateTime`!
invoiceNumber	`String`
issueDate	`ISO8601DateTime`
netAmount	`Float`
taxAmount	`Float`
totalAmount required	`Float`!
vendorProfileId required	`ModelId`!

Returns: AccountsPayableCreatePayload

Show fields

Autogenerated return type of AccountsPayableCreate.

Field	Type	Description
accountsPayable	`AccountsPayable`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

accountsPayableDelete

accountsPayableDelete(
  input: AccountsPayableDeleteInput!
): AccountsPayableDeletePayload

Input: AccountsPayableDeleteInput

Show fields

Parameters for AccountsPayableDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: AccountsPayableDeletePayload

Show fields

Autogenerated return type of AccountsPayableDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

accountsPayableUpdate

accountsPayableUpdate(
  input: AccountsPayableUpdateInput!
): AccountsPayableUpdatePayload

Input: AccountsPayableUpdateInput

Show fields

Parameters for AccountsPayableUpdate

Field	Type	Description
allocationsAttributes required	[`AllocationInput`!]
categoryId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
currency	`String`
dueDate	`ISO8601DateTime`
externalId	`ModelId`
id required	`ModelId`!
invoiceNumber	`String`
issueDate	`ISO8601DateTime`
netAmount	`Float`
taxAmount	`Float`
totalAmount	`Float`
vendorProfileId	`ModelId`

Returns: AccountsPayableUpdatePayload

Show fields

Autogenerated return type of AccountsPayableUpdate.

Field	Type	Description
accountsPayable	`AccountsPayable`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

accountsReceivableCreate

accountsReceivableCreate(
  input: AccountsReceivableCreateInput!
): AccountsReceivableCreatePayload

Input: AccountsReceivableCreateInput

Show fields

Parameters for AccountsReceivableCreate

Field	Type	Description
allocationsAttributes required	[`AllocationInput`!]
categoryId required	`ModelId`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.
clientProfileId required	`ModelId`!
currency required	`String`!
dueDate required	`ISO8601DateTime`!
externalId	`String`
invoiceNumber	`String`
issueDate	`ISO8601DateTime`
netAmount	`Float`
taxAmount	`Float`
totalAmount required	`Float`!

Returns: AccountsReceivableCreatePayload

Show fields

Autogenerated return type of AccountsReceivableCreate.

Field	Type	Description
accountsReceivable	`AccountsReceivable`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

accountsReceivableDelete

accountsReceivableDelete(
  input: AccountsReceivableDeleteInput!
): AccountsReceivableDeletePayload

Input: AccountsReceivableDeleteInput

Show fields

Parameters for AccountsReceivableDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: AccountsReceivableDeletePayload

Show fields

Autogenerated return type of AccountsReceivableDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

accountsReceivableUpdate

accountsReceivableUpdate(
  input: AccountsReceivableUpdateInput!
): AccountsReceivableUpdatePayload

Input: AccountsReceivableUpdateInput

Show fields

Parameters for AccountsReceivableUpdate

Field	Type	Description
allocationsAttributes required	[`AllocationInput`!]
categoryId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
clientProfileId	`ModelId`
currency	`String`
dueDate	`ISO8601DateTime`
externalId	`ModelId`
id required	`ModelId`!
invoiceNumber	`String`
issueDate	`ISO8601DateTime`
netAmount	`Float`
paymentDate	`ISO8601DateTime`
taxAmount	`Float`
totalAmount	`Float`

Returns: AccountsReceivableUpdatePayload

Show fields

Autogenerated return type of AccountsReceivableUpdate.

Field	Type	Description
accountsReceivable	`AccountsReceivable`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

apiKeyGenerate

Generate a new API key for programmatic access

apiKeyGenerate(
  input: ApiKeyGenerateInput!
): ApiKeyGeneratePayload

Input: ApiKeyGenerateInput

Show fields

Parameters for ApiKeyGenerate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
expiresInDays	`Int`	Number of days until expiration (omit for never-expiring key)
name required	`String`!	Friendly name for the API key
scope	`String`	Access level: read_only or read_write

Returns: ApiKeyGeneratePayload

Show fields

Autogenerated return type of ApiKeyGenerate.

Field	Type	Description
apiKey	`ApiKey`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful
token	`String`	Plaintext token (ONLY returned on creation, save securely)

apiKeyRevoke

Revoke an API key (soft delete)

apiKeyRevoke(
  input: ApiKeyRevokeInput!
): ApiKeyRevokePayload

Input: ApiKeyRevokeInput

Show fields

Parameters for ApiKeyRevoke

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ID`!	API key ID to revoke

Returns: ApiKeyRevokePayload

Show fields

Autogenerated return type of ApiKeyRevoke.

Field	Type	Description
apiKey	`ApiKey`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

balanceSnapshotCreate

Create a new balance snapshot

balanceSnapshotCreate(
  input: BalanceSnapshotCreateInput!
): BalanceSnapshotCreatePayload

Input: BalanceSnapshotCreateInput

Show fields

Parameters for BalanceSnapshotCreate

Field	Type	Description
accountId required	`ModelId`!
balance required	`Float`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.
date	`ISO8601Date`
description	`String`

Returns: BalanceSnapshotCreatePayload

Show fields

Autogenerated return type of BalanceSnapshotCreate.

Field	Type	Description
balanceSnapshot	`BalanceSnapshot`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

balanceSnapshotDelete

Delete a balance snapshot

balanceSnapshotDelete(
  input: BalanceSnapshotDeleteInput!
): BalanceSnapshotDeletePayload

Input: BalanceSnapshotDeleteInput

Show fields

Parameters for BalanceSnapshotDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: BalanceSnapshotDeletePayload

Show fields

Autogenerated return type of BalanceSnapshotDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

balanceSnapshotUpdate

Update an existing balance snapshot

balanceSnapshotUpdate(
  input: BalanceSnapshotUpdateInput!
): BalanceSnapshotUpdatePayload

Input: BalanceSnapshotUpdateInput

Show fields

Parameters for BalanceSnapshotUpdate

Field	Type	Description
balance	`Float`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
date	`ISO8601Date`
description	`String`
id required	`ModelId`!

Returns: BalanceSnapshotUpdatePayload

Show fields

Autogenerated return type of BalanceSnapshotUpdate.

Field	Type	Description
balanceSnapshot	`BalanceSnapshot`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

budgetCreate

budgetCreate(
  input: BudgetCreateInput!
): BudgetCreatePayload

Input: BudgetCreateInput

Show fields

Parameters for BudgetCreate

Field	Type	Description
allocationsAttributes required	[`AllocationInput`!]
budgetedAmount required	`Float`!
budgetedDate required	`ISO8601Date`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.
counterpartyId	`ModelId`
counterpartyType	`CounterpartyTypeEnum`
currency	`String`
description	`String`
netAmount	`Float`
taxAmount	`Float`

Returns: BudgetCreatePayload

Show fields

Autogenerated return type of BudgetCreate.

Field	Type	Description
budget	`Budget`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

budgetDelete

budgetDelete(
  input: BudgetDeleteInput!
): BudgetDeletePayload

Input: BudgetDeleteInput

Show fields

Parameters for BudgetDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: BudgetDeletePayload

Show fields

Autogenerated return type of BudgetDelete.

Field	Type	Description
budget	`Budget`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

budgetUpdate

budgetUpdate(
  input: BudgetUpdateInput!
): BudgetUpdatePayload

Input: BudgetUpdateInput

Show fields

Parameters for BudgetUpdate

Field	Type	Description
allocationsAttributes required	[`AllocationInput`!]
budgetedAmount	`Float`
budgetedDate	`ISO8601Date`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
counterpartyId	`ModelId`
counterpartyType	`CounterpartyTypeEnum`
currency	`String`
description	`String`
id required	`ModelId`!
netAmount	`Float`
taxAmount	`Float`

Returns: BudgetUpdatePayload

Show fields

Autogenerated return type of BudgetUpdate.

Field	Type	Description
budget	`Budget`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

cashAdjustmentCreate

cashAdjustmentCreate(
  input: CashAdjustmentCreateInput!
): CashAdjustmentCreatePayload

Input: CashAdjustmentCreateInput

Show fields

Parameters for CashAdjustmentCreate

Field	Type	Description
adjustmentDate required	`ISO8601DateTime`!
amount required	`Float`!
cashFlowSection required	`String`!
categoryGroupId required	`ModelId`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterId required	`ModelId`!
description	`String`
supplierOrCustomer	`String`

Returns: CashAdjustmentCreatePayload

Show fields

Autogenerated return type of CashAdjustmentCreate.

Field	Type	Description
cashAdjustment	`CashAdjustment`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

cashAdjustmentDelete

cashAdjustmentDelete(
  input: CashAdjustmentDeleteInput!
): CashAdjustmentDeletePayload

Input: CashAdjustmentDeleteInput

Show fields

Parameters for CashAdjustmentDelete

Field	Type	Description
adjustmentDate	`ISO8601DateTime`
amount	`Float`
cashFlowSection	`String`
categoryGroupId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterId	`ModelId`
description	`String`
supplierOrCustomer	`String`

Returns: CashAdjustmentDeletePayload

Show fields

Autogenerated return type of CashAdjustmentDelete.

Field	Type	Description
cashAdjustment	`CashAdjustment`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

cashAdjustmentUpdate

cashAdjustmentUpdate(
  input: CashAdjustmentUpdateInput!
): CashAdjustmentUpdatePayload

Input: CashAdjustmentUpdateInput

Show fields

Parameters for CashAdjustmentUpdate

Field	Type	Description
adjustmentDate	`ISO8601DateTime`
amount	`Float`
cashFlowSection	`String`
categoryGroupId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterId	`ModelId`
description	`String`
id required	`ModelId`!
supplierOrCustomer	`String`

Returns: CashAdjustmentUpdatePayload

Show fields

Autogenerated return type of CashAdjustmentUpdate.

Field	Type	Description
cashAdjustment	`CashAdjustment`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

categoryCreate

categoryCreate(
  input: CategoryCreateInput!
): CategoryCreatePayload

Input: CategoryCreateInput

Show fields

Parameters for CategoryCreate

Field	Type	Description
categoryGroupId	`ModelId`
categoryType	`String`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
code	`String`
name	`String`

Returns: CategoryCreatePayload

Show fields

Autogenerated return type of CategoryCreate.

Field	Type	Description
category	`Category`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

categoryDelete

categoryDelete(
  input: CategoryDeleteInput!
): CategoryDeletePayload

Input: CategoryDeleteInput

Show fields

Parameters for CategoryDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: CategoryDeletePayload

Show fields

Autogenerated return type of CategoryDelete.

Field	Type	Description
category	`Category`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

categoryGroupCreate

categoryGroupCreate(
  input: CategoryGroupCreateInput!
): CategoryGroupCreatePayload

Input: CategoryGroupCreateInput

Show fields

Parameters for CategoryGroupCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
displayOrder	`Int`
name required	`String`!

Returns: CategoryGroupCreatePayload

Show fields

Autogenerated return type of CategoryGroupCreate.

Field	Type	Description
categoryGroup	`CategoryGroup`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

categoryGroupDelete

categoryGroupDelete(
  input: CategoryGroupDeleteInput!
): CategoryGroupDeletePayload

Input: CategoryGroupDeleteInput

Show fields

Parameters for CategoryGroupDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: CategoryGroupDeletePayload

Show fields

Autogenerated return type of CategoryGroupDelete.

Field	Type	Description
categoryGroup	`CategoryGroup`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

categoryGroupUpdate

categoryGroupUpdate(
  input: CategoryGroupUpdateInput!
): CategoryGroupUpdatePayload

Input: CategoryGroupUpdateInput

Show fields

Parameters for CategoryGroupUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
displayOrder	`Int`
id required	`ModelId`!
name	`String`

Returns: CategoryGroupUpdatePayload

Show fields

Autogenerated return type of CategoryGroupUpdate.

Field	Type	Description
categoryGroup	`CategoryGroup`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

categoryUpdate

categoryUpdate(
  input: CategoryUpdateInput!
): CategoryUpdatePayload

Input: CategoryUpdateInput

Show fields

Parameters for CategoryUpdate

Field	Type	Description
categoryGroupId	`ModelId`
categoryType	`String`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
code	`String`
id required	`ModelId`!
name	`String`

Returns: CategoryUpdatePayload

Show fields

Autogenerated return type of CategoryUpdate.

Field	Type	Description
category	`Category`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

chatDelete

Delete a chat conversation

chatDelete(
  input: ChatDeleteInput!
): ChatDeletePayload

Input: ChatDeleteInput

Show fields

Parameters for ChatDelete

Field	Type	Description
chatId required	`ID`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ChatDeletePayload

Show fields

Autogenerated return type of ChatDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

chatMessageSend

Send a message to the AI chat and receive a response

chatMessageSend(
  input: ChatMessageSendInput!
): ChatMessageSendPayload

Input: ChatMessageSendInput

Show fields

Parameters for ChatMessageSend

Field	Type	Description
chatId	`ID`	ID of existing chat conversation. If not provided, a new chat will be created.
clientMutationId	`String`	A unique identifier for the client performing the mutation.
message required	`String`!	The message/query to send to the AI

Returns: ChatMessageSendPayload

Show fields

Autogenerated return type of ChatMessageSend.

Field	Type	Description
chat	`Chat`	The chat conversation
clientMutationId	`String`	A unique identifier for the client performing the mutation.
debugInfo	`DebugInfo`	Debug information (development only)
errors required	[`Error`!]!	Errors encountered during mutation execution
message	`Message`	The user’s message that was sent
response	`Message`	The AI’s response message
success required	`Boolean`!	Indicates whether the operation was successful

clientProfileCreate

clientProfileCreate(
  input: ClientProfileCreateInput!
): ClientProfileCreatePayload

Input: ClientProfileCreateInput

Show fields

Parameters for ClientProfileCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ClientProfileCreatePayload

Show fields

Autogenerated return type of ClientProfileCreate.

Field	Type	Description
client	`ClientProfile`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

clientProfileDelete

clientProfileDelete(
  input: ClientProfileDeleteInput!
): ClientProfileDeletePayload

Input: ClientProfileDeleteInput

Show fields

Parameters for ClientProfileDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ClientProfileDeletePayload

Show fields

Autogenerated return type of ClientProfileDelete.

Field	Type	Description
client	`ClientProfile`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

clientProfileUpdate

clientProfileUpdate(
  input: ClientProfileUpdateInput!
): ClientProfileUpdatePayload

Input: ClientProfileUpdateInput

Show fields

Parameters for ClientProfileUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ClientProfileUpdatePayload

Show fields

Autogenerated return type of ClientProfileUpdate.

Field	Type	Description
client	`ClientProfile`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

commentCreate

commentCreate(
  input: CommentCreateInput!
): CommentCreatePayload

Input: CommentCreateInput

Show fields

Parameters for CommentCreate

Field	Type	Description
categoryPath required	[`String`!]
clientMutationId	`String`	A unique identifier for the client performing the mutation.
content required	`String`!
idempotencyKey	`String`
month required	`String`!
parentId	`ModelId`
rowId required	`String`!
rowLabel required	`String`!

Returns: CommentCreatePayload

Show fields

Autogenerated return type of CommentCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
comment	`Comment`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

commentDelete

commentDelete(
  input: CommentDeleteInput!
): CommentDeletePayload

Input: CommentDeleteInput

Show fields

Parameters for CommentDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: CommentDeletePayload

Show fields

Autogenerated return type of CommentDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
comment	`Comment`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

commentResolve

Resolve a comment

commentResolve(
  input: CommentResolveInput!
): CommentResolvePayload

Input: CommentResolveInput

Show fields

Parameters for CommentResolve

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!	Comment ID

Returns: CommentResolvePayload

Show fields

Autogenerated return type of CommentResolve.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
comment	`Comment`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

commentUnresolve

Unresolve a comment

commentUnresolve(
  input: CommentUnresolveInput!
): CommentUnresolvePayload

Input: CommentUnresolveInput

Show fields

Parameters for CommentUnresolve

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!	Comment ID

Returns: CommentUnresolvePayload

Show fields

Autogenerated return type of CommentUnresolve.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
comment	`Comment`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

commentUpdate

commentUpdate(
  input: CommentUpdateInput!
): CommentUpdatePayload

Input: CommentUpdateInput

Show fields

Parameters for CommentUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
content required	`String`!
id required	`ModelId`!

Returns: CommentUpdatePayload

Show fields

Autogenerated return type of CommentUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
comment	`Comment`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

companyArchive

companyArchive(
  input: CompanyArchiveInput!
): CompanyArchivePayload

Input: CompanyArchiveInput

Show fields

Parameters for CompanyArchive

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ID`!

Returns: CompanyArchivePayload

Show fields

Autogenerated return type of CompanyArchive.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
company	`Company`
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

companyCreate

companyCreate(
  input: CompanyCreateInput!
): CompanyCreatePayload

Input: CompanyCreateInput

Show fields

Parameters for CompanyCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
cnpj required	`String`!
description	`String`
name required	`String`!
status	`String`

Returns: CompanyCreatePayload

Show fields

Autogenerated return type of CompanyCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
company	`Company`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

companyUpdate

companyUpdate(
  input: CompanyUpdateInput!
): CompanyUpdatePayload

Input: CompanyUpdateInput

Show fields

Parameters for CompanyUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
cnpj required	`String`!
description	`String`
id required	`ID`!
name required	`String`!
status	`String`

Returns: CompanyUpdatePayload

Show fields

Autogenerated return type of CompanyUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
company	`Company`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

contaAzulAuthorize

Generate ContaAzul OAuth authorization URL

contaAzulAuthorize(
  input: ContaAzulAuthorizeInput!
): ContaAzulAuthorizePayload!

Input: ContaAzulAuthorizeInput

Show fields

Parameters for ContaAzulAuthorize

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ContaAzulAuthorizePayload

Show fields

Autogenerated return type of ContaAzulAuthorize.

Field	Type	Description
authorizationUrl required	`String`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

contactCreate

contactCreate(
  input: ContactCreateInput!
): ContactCreatePayload

Input: ContactCreateInput

Show fields

Parameters for ContactCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
companyName required	`String`!
contactProfiles	`String`
contactType required	`String`!
email	`String`
identifier	`String`
identifierValue	`String`
notes	`String`
phone	`String`
status required	`String`!
tradeName	`String`

Returns: ContactCreatePayload

Show fields

Autogenerated return type of ContactCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
contact	`Contact`
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

contactDelete

contactDelete(
  input: ContactDeleteInput!
): ContactDeletePayload

Input: ContactDeleteInput

Show fields

Parameters for ContactDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: ContactDeletePayload

Show fields

Autogenerated return type of ContactDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

contactUpdate

contactUpdate(
  input: ContactUpdateInput!
): ContactUpdatePayload

Input: ContactUpdateInput

Show fields

Parameters for ContactUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
companyName	`String`
contactProfiles	`String`
contactType required	`String`!
email	`String`
id required	`ModelId`!
identifier	`String`
identifierValue	`String`
notes	`String`
phone	`String`
status required	`String`!
tradeName	`String`

Returns: ContactUpdatePayload

Show fields

Autogenerated return type of ContactUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
contact	`Contact`
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

costCenterAllocationRuleCreate

costCenterAllocationRuleCreate(
  input: CostCenterAllocationRuleCreateInput!
): CostCenterAllocationRuleCreatePayload

Input: CostCenterAllocationRuleCreateInput

Show fields

Parameters for CostCenterAllocationRuleCreate

Field	Type	Description
categoryId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterId required	`ModelId`!
departmentId	`ModelId`
priority	`Int`

Returns: CostCenterAllocationRuleCreatePayload

Show fields

Autogenerated return type of CostCenterAllocationRuleCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterAllocationRule	`CostCenterAllocationRule`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

costCenterAllocationRuleDelete

costCenterAllocationRuleDelete(
  input: CostCenterAllocationRuleDeleteInput!
): CostCenterAllocationRuleDeletePayload

Input: CostCenterAllocationRuleDeleteInput

Show fields

Parameters for CostCenterAllocationRuleDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: CostCenterAllocationRuleDeletePayload

Show fields

Autogenerated return type of CostCenterAllocationRuleDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterAllocationRule	`CostCenterAllocationRule`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

costCenterAllocationRuleUpdate

costCenterAllocationRuleUpdate(
  input: CostCenterAllocationRuleUpdateInput!
): CostCenterAllocationRuleUpdatePayload

Input: CostCenterAllocationRuleUpdateInput

Show fields

Parameters for CostCenterAllocationRuleUpdate

Field	Type	Description
categoryId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterId	`ModelId`
departmentId	`ModelId`
id required	`ModelId`!
priority	`Int`

Returns: CostCenterAllocationRuleUpdatePayload

Show fields

Autogenerated return type of CostCenterAllocationRuleUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterAllocationRule	`CostCenterAllocationRule`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

costCenterCreate

costCenterCreate(
  input: CostCenterCreateInput!
): CostCenterCreatePayload

Input: CostCenterCreateInput

Show fields

Parameters for CostCenterCreate

Field	Type	Description
cashFlowSection	`String`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterGroupId	`ModelId`
description	`String`
name	`String`
status	`String`

Returns: CostCenterCreatePayload

Show fields

Autogenerated return type of CostCenterCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenter	`CostCenter`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

costCenterDelete

costCenterDelete(
  input: CostCenterDeleteInput!
): CostCenterDeletePayload

Input: CostCenterDeleteInput

Show fields

Parameters for CostCenterDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: CostCenterDeletePayload

Show fields

Autogenerated return type of CostCenterDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenter	`CostCenter`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

costCenterGroupCreate

costCenterGroupCreate(
  input: CostCenterGroupCreateInput!
): CostCenterGroupCreatePayload

Input: CostCenterGroupCreateInput

Show fields

Parameters for CostCenterGroupCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: CostCenterGroupCreatePayload

Show fields

Autogenerated return type of CostCenterGroupCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterGroup	`CostCenterGroup`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

costCenterUpdate

costCenterUpdate(
  input: CostCenterUpdateInput!
): CostCenterUpdatePayload

Input: CostCenterUpdateInput

Show fields

Parameters for CostCenterUpdate

Field	Type	Description
cashFlowSection	`String`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterGroupId	`ModelId`
description	`String`
id required	`ModelId`!
name	`String`
status	`String`

Returns: CostCenterUpdatePayload

Show fields

Autogenerated return type of CostCenterUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenter	`CostCenter`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

currencyCreate

currencyCreate(
  input: CurrencyCreateInput!
): CurrencyCreatePayload

Input: CurrencyCreateInput

Show fields

Parameters for CurrencyCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: CurrencyCreatePayload

Show fields

Autogenerated return type of CurrencyCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
currency	`Currency`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

currencyDelete

currencyDelete(
  input: CurrencyDeleteInput!
): CurrencyDeletePayload

Input: CurrencyDeleteInput

Show fields

Parameters for CurrencyDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: CurrencyDeletePayload

Show fields

Autogenerated return type of CurrencyDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
currency	`Currency`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

currencyUpdate

currencyUpdate(
  input: CurrencyUpdateInput!
): CurrencyUpdatePayload

Input: CurrencyUpdateInput

Show fields

Parameters for CurrencyUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: CurrencyUpdatePayload

Show fields

Autogenerated return type of CurrencyUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
currency	`Currency`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

deferralCreate

deferralCreate(
  input: DeferralCreateInput!
): DeferralCreatePayload

Input: DeferralCreateInput

Show fields

Parameters for DeferralCreate

Field	Type	Description
accrualDate required	`ISO8601DateTime`!
amount required	`Float`!
categoryGroupId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterId	`ModelId`
description	`String`
supplierOrCustomer	`String`

Returns: DeferralCreatePayload

Show fields

Autogenerated return type of DeferralCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
deferral	`Deferral`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

deferralDelete

deferralDelete(
  input: DeferralDeleteInput!
): DeferralDeletePayload

Input: DeferralDeleteInput

Show fields

Parameters for DeferralDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: DeferralDeletePayload

Show fields

Autogenerated return type of DeferralDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
deferral	`Deferral`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

deferralUpdate

deferralUpdate(
  input: DeferralUpdateInput!
): DeferralUpdatePayload

Input: DeferralUpdateInput

Show fields

Parameters for DeferralUpdate

Field	Type	Description
accrualDate	`ISO8601DateTime`
amount	`Float`
categoryGroupId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
costCenterId	`ModelId`
description	`String`
id required	`ModelId`!
supplierOrCustomer	`String`

Returns: DeferralUpdatePayload

Show fields

Autogenerated return type of DeferralUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
deferral	`Deferral`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

departmentCreate

departmentCreate(
  input: DepartmentCreateInput!
): DepartmentCreatePayload

Input: DepartmentCreateInput

Show fields

Parameters for DepartmentCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
name	`String`

Returns: DepartmentCreatePayload

Show fields

Autogenerated return type of DepartmentCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
department	`Department`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

departmentDelete

departmentDelete(
  input: DepartmentDeleteInput!
): DepartmentDeletePayload

Input: DepartmentDeleteInput

Show fields

Parameters for DepartmentDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: DepartmentDeletePayload

Show fields

Autogenerated return type of DepartmentDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
department	`Department`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

departmentUpdate

departmentUpdate(
  input: DepartmentUpdateInput!
): DepartmentUpdatePayload

Input: DepartmentUpdateInput

Show fields

Parameters for DepartmentUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!
name	`String`

Returns: DepartmentUpdatePayload

Show fields

Autogenerated return type of DepartmentUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
department	`Department`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

exchangeRateCreate

exchangeRateCreate(
  input: ExchangeRateCreateInput!
): ExchangeRateCreatePayload

Input: ExchangeRateCreateInput

Show fields

Parameters for ExchangeRateCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ExchangeRateCreatePayload

Show fields

Autogenerated return type of ExchangeRateCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
exchangeRate	`ExchangeRate`
success required	`Boolean`!	Indicates whether the operation was successful

exchangeRateDelete

exchangeRateDelete(
  input: ExchangeRateDeleteInput!
): ExchangeRateDeletePayload

Input: ExchangeRateDeleteInput

Show fields

Parameters for ExchangeRateDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ExchangeRateDeletePayload

Show fields

Autogenerated return type of ExchangeRateDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
exchangeRate	`ExchangeRate`
success required	`Boolean`!

exchangeRateUpdate

exchangeRateUpdate(
  input: ExchangeRateUpdateInput!
): ExchangeRateUpdatePayload

Input: ExchangeRateUpdateInput

Show fields

Parameters for ExchangeRateUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: ExchangeRateUpdatePayload

Show fields

Autogenerated return type of ExchangeRateUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
exchangeRate	`ExchangeRate`
success required	`Boolean`!	Indicates whether the operation was successful

googleSheetsAuthorize

Initiate Google Sheets OAuth authorization flow

googleSheetsAuthorize(
  input: GoogleSheetsAuthorizeInput!
): GoogleSheetsAuthorizePayload

Input: GoogleSheetsAuthorizeInput

Show fields

Parameters for GoogleSheetsAuthorize

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: GoogleSheetsAuthorizePayload

Show fields

Autogenerated return type of GoogleSheetsAuthorize.

Field	Type	Description
authorizationUrl required	`String`!	URL to redirect user for Google authorization
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!	Indicates whether the operation was successful

googleSheetsConnect

Complete Google Sheets OAuth flow and create integration

googleSheetsConnect(
  input: GoogleSheetsConnectInput!
): GoogleSheetsConnectPayload

Input: GoogleSheetsConnectInput

Show fields

Parameters for GoogleSheetsConnect

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
code required	`String`!	Authorization code from Google OAuth callback
state required	`String`!	State parameter from OAuth flow

Returns: GoogleSheetsConnectPayload

Show fields

Autogenerated return type of GoogleSheetsConnect.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
provider	`Provider`
spreadsheetUrl	`String`	URL of the created Google Sheets
success required	`Boolean`!

googleSheetsDisconnect

Disconnect Google Sheets integration

googleSheetsDisconnect(
  input: GoogleSheetsDisconnectInput!
): GoogleSheetsDisconnectPayload

Input: GoogleSheetsDisconnectInput

Show fields

Parameters for GoogleSheetsDisconnect

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: GoogleSheetsDisconnectPayload

Show fields

Autogenerated return type of GoogleSheetsDisconnect.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

importCreate

importCreate(
  input: ImportCreateInput!
): ImportCreatePayload

Input: ImportCreateInput

Show fields

Parameters for ImportCreate

Field	Type	Description
accountId	`ID`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
data required	[`JSON`!]!
dryRun	`Boolean`
entityType required	`ImportEntity`!
overridePreviousImports	`Boolean`

Returns: ImportCreatePayload

Show fields

Autogenerated return type of ImportCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
import	`Import`
invalidRecords	`Int`
previewData required	[`JSON`!]
success required	`Boolean`!	Indicates whether the operation was successful
validRecords	`Int`
warnings required	[`String`!]

importRetryFailed

importRetryFailed(
  input: ImportRetryFailedInput!
): ImportRetryFailedPayload

Input: ImportRetryFailedInput

Show fields

Parameters for ImportRetryFailed

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
importId required	`ID`!

Returns: ImportRetryFailedPayload

Show fields

Autogenerated return type of ImportRetryFailed.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
import	`Import`
retriedCount	`Int`
success required	`Boolean`!	Indicates whether the operation was successful

messageFeedbackCreate

Create or update feedback for an LLM message

messageFeedbackCreate(
  input: MessageFeedbackCreateInput!
): MessageFeedbackCreatePayload

Input: MessageFeedbackCreateInput

Show fields

Parameters for MessageFeedbackCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
comment	`String`
feedbackType required	`String`!
messageId required	`ID`!

Returns: MessageFeedbackCreatePayload

Show fields

Autogenerated return type of MessageFeedbackCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
feedback	`MessageFeedback`
success required	`Boolean`!	Indicates whether the operation was successful

messageFeedbackDelete

Delete feedback for an LLM message

messageFeedbackDelete(
  input: MessageFeedbackDeleteInput!
): MessageFeedbackDeletePayload

Input: MessageFeedbackDeleteInput

Show fields

Parameters for MessageFeedbackDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
messageId required	`ID`!

Returns: MessageFeedbackDeletePayload

Show fields

Autogenerated return type of MessageFeedbackDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

notificationMarkAllAsRead

notificationMarkAllAsRead(
  input: NotificationMarkAllAsReadInput!
): NotificationMarkAllAsReadPayload

Input: NotificationMarkAllAsReadInput

Show fields

Parameters for NotificationMarkAllAsRead

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: NotificationMarkAllAsReadPayload

Show fields

Autogenerated return type of NotificationMarkAllAsRead.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
count required	`Int`!
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful

notificationMarkAsRead

notificationMarkAsRead(
  input: NotificationMarkAsReadInput!
): NotificationMarkAsReadPayload

Input: NotificationMarkAsReadInput

Show fields

Parameters for NotificationMarkAsRead

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ID`!

Returns: NotificationMarkAsReadPayload

Show fields

Autogenerated return type of NotificationMarkAsRead.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
notification	`Notification`
success required	`Boolean`!	Indicates whether the operation was successful

organizationCreate

organizationCreate(
  input: OrganizationCreateInput!
): OrganizationCreatePayload

Input: OrganizationCreateInput

Show fields

Parameters for OrganizationCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
name required	`String`!
status	`String`

Returns: OrganizationCreatePayload

Show fields

Autogenerated return type of OrganizationCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
organization	`Organization`
success required	`Boolean`!	Indicates whether the operation was successful

organizationDelete

organizationDelete(
  input: OrganizationDeleteInput!
): OrganizationDeletePayload

Input: OrganizationDeleteInput

Show fields

Parameters for OrganizationDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: OrganizationDeletePayload

Show fields

Autogenerated return type of OrganizationDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

organizationUpdate

organizationUpdate(
  input: OrganizationUpdateInput!
): OrganizationUpdatePayload

Input: OrganizationUpdateInput

Show fields

Parameters for OrganizationUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!
name	`String`
status	`String`

Returns: OrganizationUpdatePayload

Show fields

Autogenerated return type of OrganizationUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
organization	`Organization`
success required	`Boolean`!	Indicates whether the operation was successful

organizationUserCreate

Add a user to the current organization

organizationUserCreate(
  input: OrganizationUserCreateInput!
): OrganizationUserCreatePayload

Input: OrganizationUserCreateInput

Show fields

Parameters for OrganizationUserCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
createUserIfNotExists	`Boolean`
email required	`String`!
firstName	`String`
isAdmin	`Boolean`
lastName	`String`

Returns: OrganizationUserCreatePayload

Show fields

Autogenerated return type of OrganizationUserCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`String`!]!
organizationUser	`OrganizationUser`
success required	`Boolean`!	Indicates whether the operation was successful

paymentApplicationCreate

Create a new payment application

paymentApplicationCreate(
  input: PaymentApplicationCreateInput!
): PaymentApplicationCreatePayload

Input: PaymentApplicationCreateInput

Show fields

Parameters for PaymentApplicationCreate

Field	Type	Description
amountApplied required	`Float`!	Amount applied to the document
applicationDate required	`ISO8601DateTime`!	Date of the application
clientMutationId	`String`	A unique identifier for the client performing the mutation.
documentId required	`ModelId`!	ID of the document being paid
documentType required	`String`!	Type of document (e.g., ‘Accounting::AccountsPayable’, ‘Accounting::AccountsReceivable’)
interestAmount	`Float`	Interest amount included in the payment
paymentId	`ModelId`	ID of the payment (Banking::Transaction)
penalty	`Float`	Penalty amount included in the payment

Returns: PaymentApplicationCreatePayload

Show fields

Autogenerated return type of PaymentApplicationCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
paymentApplication	`PaymentApplication`
success required	`Boolean`!

paymentApplicationDelete

Delete a payment application

paymentApplicationDelete(
  input: PaymentApplicationDeleteInput!
): PaymentApplicationDeletePayload

Input: PaymentApplicationDeleteInput

Show fields

Parameters for PaymentApplicationDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: PaymentApplicationDeletePayload

Show fields

Autogenerated return type of PaymentApplicationDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

paymentApplicationUpdate

Update an existing payment application

paymentApplicationUpdate(
  input: PaymentApplicationUpdateInput!
): PaymentApplicationUpdatePayload

Input: PaymentApplicationUpdateInput

Show fields

Parameters for PaymentApplicationUpdate

Field	Type	Description
amountApplied	`Float`	Amount applied to the document
applicationDate	`ISO8601DateTime`	Date of the application
clientMutationId	`String`	A unique identifier for the client performing the mutation.
documentId	`ModelId`	ID of the document being paid
documentType	`String`	Type of document (e.g., ‘Accounting::AccountsPayable’, ‘Accounting::AccountsReceivable’)
id required	`ModelId`!	ID of the payment application to update
interestAmount	`Float`	Interest amount included in the payment
paymentId	`ModelId`	ID of the payment (Banking::Transaction)
penalty	`Float`	Penalty amount included in the payment

Returns: PaymentApplicationUpdatePayload

Show fields

Autogenerated return type of PaymentApplicationUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
paymentApplication	`PaymentApplication`
success required	`Boolean`!

providerCreate

providerCreate(
  input: ProviderCreateInput!
): ProviderCreatePayload

Input: ProviderCreateInput

Show fields

Parameters for ProviderCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
configuration	`JSON`
credentials required	`JSON`!
name	`String`
providerType required	`String`!
status	`String`
syncDirection	`String`
syncEnabled	`Boolean`

Returns: ProviderCreatePayload

Show fields

Autogenerated return type of ProviderCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
provider	`Provider`
success required	`Boolean`!	Indicates whether the operation was successful

providerDelete

providerDelete(
  input: ProviderDeleteInput!
): ProviderDeletePayload

Input: ProviderDeleteInput

Show fields

Parameters for ProviderDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ID`!

Returns: ProviderDeletePayload

Show fields

Autogenerated return type of ProviderDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

providerUpdate

providerUpdate(
  input: ProviderUpdateInput!
): ProviderUpdatePayload

Input: ProviderUpdateInput

Show fields

Parameters for ProviderUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
configuration	`JSON`
credentials	`JSON`
id required	`ModelId`!
name	`String`
providerType	`String`
status	`String`
syncDirection	`String`
syncEnabled	`Boolean`

Returns: ProviderUpdatePayload

Show fields

Autogenerated return type of ProviderUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
provider	`Provider`
success required	`Boolean`!	Indicates whether the operation was successful

retryFailedRecords

Retry syncing failed records for a provider or sync execution

retryFailedRecords(
  input: RetryFailedRecordsInput!
): RetryFailedRecordsPayload

Input: RetryFailedRecordsInput

Show fields

Parameters for RetryFailedRecords

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
providerId	`ID`
recordIds required	[`ID`!]	Specific records to retry
syncExecutionId	`ID`

Returns: RetryFailedRecordsPayload

Show fields

Autogenerated return type of RetryFailedRecords.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
retriedCount required	`Int`!
success required	`Boolean`!

transactionCreate

transactionCreate(
  input: TransactionCreateInput!
): TransactionCreatePayload

Input: TransactionCreateInput

Show fields

Parameters for TransactionCreate

Field	Type	Description
accountId required	`ModelId`!
amount required	`Float`!
clientMutationId	`String`	A unique identifier for the client performing the mutation.
createDocument	`Boolean`
description required	`String`!
documentAmount	`Float`
documentDueDate	`ISO8601Date`
documentInvoiceNumber	`String`
documentType	`String`
relatedAccountId	`ModelId`
transactionDate required	`ISO8601DateTime`!

Returns: TransactionCreatePayload

Show fields

Autogenerated return type of TransactionCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful
transaction	`Transaction`

transactionDelete

Delete a banking transaction

transactionDelete(
  input: TransactionDeleteInput!
): TransactionDeletePayload

Input: TransactionDeleteInput

Show fields

Parameters for TransactionDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
id required	`ModelId`!

Returns: TransactionDeletePayload

Show fields

Autogenerated return type of TransactionDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!

transactionUpdate

transactionUpdate(
  input: TransactionUpdateInput!
): TransactionUpdatePayload

Input: TransactionUpdateInput

Show fields

Parameters for TransactionUpdate

Field	Type	Description
accountId	`ModelId`
amount	`Float`
categoryId	`ModelId`
clientMutationId	`String`	A unique identifier for the client performing the mutation.
description	`String`
id required	`ModelId`!
transactionDate	`ISO8601DateTime`

Returns: TransactionUpdatePayload

Show fields

Autogenerated return type of TransactionUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful
transaction	`Transaction`

triggerSync

triggerSync(
  input: TriggerSyncInput!
): TriggerSyncPayload

Input: TriggerSyncInput

Show fields

Parameters for TriggerSync

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
providerId required	`ID`!

Returns: TriggerSyncPayload

Show fields

Autogenerated return type of TriggerSync.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!
success required	`Boolean`!
syncExecution	`IntegrationsSyncExecution`

userSignin

userSignin(
  input: UserSigninInput!
): UserSigninPayload

Input: UserSigninInput

Show fields

Parameters for UserSignin

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
email	`String`	The email of the participant

Returns: UserSigninPayload

Show fields

Autogenerated return type of UserSignin.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errorType	`String`
errors required	[`Error`!]!	Errors encountered during mutation execution
message	`String`
metadata	`JSON`
otpBrowserToken	`String`
success required	`Boolean`!
user	`User`

userSignout

Sign out

userSignout(
  input: UserSignoutInput!
): UserSignoutPayload

Input: UserSignoutInput

Show fields

Parameters for UserSignout

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: UserSignoutPayload

Show fields

Autogenerated return type of UserSignout.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
error	`String`
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!

userVerifyOtp

Verify OTP code

userVerifyOtp(
  input: UserVerifyOtpInput!
): UserVerifyOtpPayload

Input: UserVerifyOtpInput

Show fields

Parameters for UserVerifyOtp

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
code required	`String`!	The OTP code to verify
otpBrowserToken	`String`	The OTP browser token

Returns: UserVerifyOtpPayload

Show fields

Autogenerated return type of UserVerifyOtp.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errorType	`String`
errors required	[`Error`!]!	Errors encountered during mutation execution
message	`String`
success required	`Boolean`!
user	`User`

vendorProfileCreate

vendorProfileCreate(
  input: VendorProfileCreateInput!
): VendorProfileCreatePayload

Input: VendorProfileCreateInput

Show fields

Parameters for VendorProfileCreate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: VendorProfileCreatePayload

Show fields

Autogenerated return type of VendorProfileCreate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful
vendor	`VendorProfile`

vendorProfileDelete

vendorProfileDelete(
  input: VendorProfileDeleteInput!
): VendorProfileDeletePayload

Input: VendorProfileDeleteInput

Show fields

Parameters for VendorProfileDelete

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: VendorProfileDeletePayload

Show fields

Autogenerated return type of VendorProfileDelete.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!
vendor	`VendorProfile`

vendorProfileUpdate

vendorProfileUpdate(
  input: VendorProfileUpdateInput!
): VendorProfileUpdatePayload

Input: VendorProfileUpdateInput

Show fields

Parameters for VendorProfileUpdate

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.

Returns: VendorProfileUpdatePayload

Show fields

Autogenerated return type of VendorProfileUpdate.

Field	Type	Description
clientMutationId	`String`	A unique identifier for the client performing the mutation.
errors required	[`Error`!]!	Errors encountered during mutation execution
success required	`Boolean`!	Indicates whether the operation was successful
vendor	`VendorProfile`

Começar

Guias

Importações

Referência da API

Changelog

​GraphQL Mutations

​accountCreate

​accountDelete

​accountUpdate

​accountsPayableCreate

​accountsPayableDelete

​accountsPayableUpdate

​accountsReceivableCreate

​accountsReceivableDelete

​accountsReceivableUpdate

​apiKeyGenerate

​apiKeyRevoke

​balanceSnapshotCreate

​balanceSnapshotDelete

​balanceSnapshotUpdate

​budgetCreate

​budgetDelete

​budgetUpdate

​cashAdjustmentCreate

​cashAdjustmentDelete

​cashAdjustmentUpdate

​categoryCreate

​categoryDelete

​categoryGroupCreate

​categoryGroupDelete

​categoryGroupUpdate

​categoryUpdate

​chatDelete

​chatMessageSend

​clientProfileCreate

​clientProfileDelete

​clientProfileUpdate

​commentCreate

​commentDelete

​commentResolve

​commentUnresolve

​commentUpdate

​companyArchive

​companyCreate

​companyUpdate

​contaAzulAuthorize

​contactCreate

​contactDelete

​contactUpdate

​costCenterAllocationRuleCreate

​costCenterAllocationRuleDelete

​costCenterAllocationRuleUpdate

​costCenterCreate

​costCenterDelete

​costCenterGroupCreate

​costCenterUpdate

​currencyCreate

​currencyDelete

​currencyUpdate

​deferralCreate

​deferralDelete

​deferralUpdate

​departmentCreate

​departmentDelete

​departmentUpdate

​exchangeRateCreate

​exchangeRateDelete

​exchangeRateUpdate

​googleSheetsAuthorize

​googleSheetsConnect

​googleSheetsDisconnect

​importCreate

​importRetryFailed

​messageFeedbackCreate

​messageFeedbackDelete

​notificationMarkAllAsRead

​notificationMarkAsRead

​organizationCreate

​organizationDelete

​organizationUpdate

GraphQL Mutations

accountCreate

accountDelete

accountUpdate

accountsPayableCreate

accountsPayableDelete

accountsPayableUpdate

accountsReceivableCreate

accountsReceivableDelete

accountsReceivableUpdate

apiKeyGenerate

apiKeyRevoke

balanceSnapshotCreate

balanceSnapshotDelete

balanceSnapshotUpdate

budgetCreate

budgetDelete

budgetUpdate

cashAdjustmentCreate

cashAdjustmentDelete

cashAdjustmentUpdate

categoryCreate

categoryDelete

categoryGroupCreate

categoryGroupDelete

categoryGroupUpdate

categoryUpdate

chatDelete

chatMessageSend

clientProfileCreate

clientProfileDelete

clientProfileUpdate

commentCreate

commentDelete

commentResolve

commentUnresolve

commentUpdate

companyArchive

companyCreate

companyUpdate

contaAzulAuthorize

contactCreate

contactDelete

contactUpdate

costCenterAllocationRuleCreate

costCenterAllocationRuleDelete

costCenterAllocationRuleUpdate

costCenterCreate

costCenterDelete

costCenterGroupCreate

costCenterUpdate

currencyCreate

currencyDelete

currencyUpdate

deferralCreate

deferralDelete

deferralUpdate

departmentCreate

departmentDelete

departmentUpdate

exchangeRateCreate

exchangeRateDelete

exchangeRateUpdate

googleSheetsAuthorize

googleSheetsConnect

googleSheetsDisconnect

importCreate

importRetryFailed

messageFeedbackCreate

messageFeedbackDelete

notificationMarkAllAsRead

notificationMarkAsRead

organizationCreate

organizationDelete

organizationUpdate

organizationUserCreate

paymentApplicationCreate

paymentApplicationDelete

paymentApplicationUpdate

providerCreate