addCompanyEmail
Add an email address to the company. This will just add the current address to the existing ones.
addCompanyLinkedin
Add a Linkedin to the company. This will just add the current Linkedin to the existing ones.
addCompanyPhone
Add a phone number to the company. This will just add the current number to the existing ones.
addCompanyWebsite
Add a website to the company. This will just add the current website to the existing ones.
addContactEmail
Add an email address to the contact. This will just add the current address to the existing ones.
addContactLinkedin
Add a Linkedin to the contact. This will just add the current Linkedin to the existing ones.
addContactPhone
Add a phone number to the contact. This will just add the current number to the existing ones.
addContactWebsite
Add a website to the contact. This will just add the current website to the existing ones.
addFollower
Add a follower for a given instance.
addPersonEmail
Add an email address to the person. This will just add the current address to the existing ones.
addPersonLinkedin
Add a Linkedin to the person. This will just add the current Linkedin to the existing ones.
addPersonPhone
Add a phone number to the person. This will just add the current phone number to the existing ones.
addPersonWebsite
Add a website to the person. This will just add the current website to the existing ones.
addUserPhone
Add a phone number to the user. This will just add the current number to the existing ones.
applyTaskBundle
Apply a task bundle to a target project or contract. Spawns independent task instances.
approveApproval
Approve an approval as the current user.
approveExpense
Approve a submitted expense by hand, without an approval flow. Refused while an approval flow is running on it: the flow approves the expense when it completes.
archiveApproval
Archive (soft-delete) an approval.
assignRole
Assign a role for the user.
billReadings
Create invoices from selected readings.
bulkMutation
Run a bulk mutation.
cancelExpensePayment
Take back a scheduled payment of an approved expense. Its payment status returns to UNPAID.
checkIntegrationStatus
Check the status of an integration.
confirmTotpSetup
Confirm TOTP Setup.
convertTaskToRecurring
Convert a normal task into a recurring template.
createAccessToken
Create an access token.
createActFromQuote
Create an act from a quote.
createActType
Create a new act type.
createAct
Create a new act.
createApprovalApprover
Add an approver to an approval.
createApproval
Create a new approval.
createComment
Create a new comment.
createCompany
Create a new company.
createContact
Create a new contact.
createContractType
Create a new contract type.
createContract
Create a new contract.
createCoordinationGroup
Create a new coordination group.
createCoordinationStage
Create a new coordination stage.
createCoordinationType
Create a new coordination type.
createCoordination
Create a new coordination.
createCreditInvoice
Create a draft credit invoice for a finalized invoice. The draft copies the invoice's client, currency, price list, discount, related records and lines, with every line quantity negated so the totals reverse the original. Edit it for a partial credit, then issue it with finalizeInvoice. If the invoice already has a draft credit invoice the caller can see, that draft is returned instead. Requires permission to void and credit invoices and edit rights on the invoice.
createDashboard
Create a new dashboard.
createDashlet
Create a new dashlet.
createDownloadLink
Create a file's download link.
createEasementType
Create a new easement type.
createEasement
Create a new easement.
createESigningSignatory
Create a new e-signing signatory.
createESigning
Create a new e-signing.
createExpense
Create a new expense.
createGovernanceDocumentType
Create a new governance document type.
createGovernanceDocument
Create a new governance document.
createInvoiceFromAct
Create an invoice from an act.
createInvoiceFromQuote
Create an invoice from a quote.
createInvoice
Create a new invoice.
createLetterSource
Create a new letter source.
createLetterType
Create a new letter type.
createLetter
Create a new letter.
createMeterManufacturer
Create a new meter manufacturer.
createMeterModel
Create a new meter model.
createMeterNominalValue
Create a new meter nominal value.
createMeter
Create a new meter.
createNumberingFunction
Create a new numbering function.
createNumberingSeries
Create a new numbering series.
createOrdinanceType
Use createGovernanceDocumentType instead
createOrdinance
Use createGovernanceDocument instead
createPerson
Create a new person.
createPriceList
Create a new price list.
createProductGroup
Create a new product group.
createProduct
Create a new product.
createProject
Create a new project.
createProperty
Create a new property.
createQuoteFromAct
Create a new quote from an act.
createQuote
Create a new quote.
createReading
Create a new reading.
createRole
Create a new role.
createSpecificationType
Create a new specification type.
createSpecification
Create a new specification.
createStatus
Create a new status.
createSubmissionSource
Create a new submission source.
createSubmissionType
Create a new submission type.
createSubmission
Create a new submission.
createTag
Create a new tag.
createTaskAutomation
Create a task automation (template) in a single transaction. Combines createTask + convertTaskToRecurring.
createTaskBundle
Create a new task bundle.
createTaskType
Create a new task type.
createTask
Create a new task.
createTaxRate
Create a new tax rate.
createTemplate
Create a new template.
createTypeGroup
Create a new type group.
createView
Create a new view.
createWebhook
Create a new webhook.
deleteAccountLogo
Delete the account's logo.
deleteActType
Delete an act type.
deleteAct
Delete an act.
deleteApprovalApprover
Remove an approver from an approval. The last approver cannot be removed, and the approval is completed when no approver is left pending.
deleteComment
Delete a comment.
deleteCompanyAddress
Delete the company's address details.
deleteCompany
Delete a company.
deleteContactAddress
Delete the contact's address details.
deleteContactMeansOfContact
Delete a contact's means of contact.
deleteContact
Delete a contact.
deleteContractType
Delete an contract type.
deleteContract
Delete a contract.
deleteCoordinationGroup
Delete a coordination group.
deleteCoordinationStage
Delete a coordination stage.
deleteCoordinationType
Delete a coordination type.
deleteCoordination
Delete a coordination.
deleteDashboard
Delete a dashboard.
deleteDashlet
Delete a dashlet.
deleteEasementType
Delete a easement type.
deleteEasement
Delete an easement.
deleteESigningSignatory
Delete an e-signing signatory.
deleteESigning
Delete an e-signing.
deleteExpense
Delete an expense.
deleteFile
Delete a file.
deleteGovernanceDocumentType
Delete a governance document type.
deleteGovernanceDocument
Delete a governance document.
deleteInvoice
Delete an invoice.
deleteLetterSource
Delete a letter source.
deleteLetterType
Delete a letter type.
deleteLetter
Delete a letter.
deleteMeterManufacturer
Delete a meter manufacturer.
deleteMeterModel
Delete a meter model.
deleteMeterNominalValue
Delete a meter nominal value.
deleteMeter
Delete a meter.
deleteNumberingFunction
Delete a numbering function.
deleteNumberingSeries
Delete a numbering series.
deleteOrdinanceType
Use deleteGovernanceDocumentType instead
deleteOrdinance
Use deleteGovernanceDocument instead
deletePersonAddress
Delete the contact's address details.
deletePerson
Delete a person.
deletePriceList
Delete a price list.
deleteProductGroup
Delete a product group.
deleteProduct
Delete a product.
deleteProject
Delete a project.
deleteProperty
Delete a property.
deleteQuote
Delete an quote.
deleteReading
Delete a reading.
deleteRole
Delete a role.
deleteSpecificationType
Delete a specification type.
deleteSpecification
Delete a specification.
deleteStatus
Delete a status.
deleteSubmissionSource
Delete a submission source.
deleteSubmissionType
Delete an submission type.
deleteSubmission
Delete a submission.
deleteTag
Delete a tag.
deleteTaskBundle
Delete a task bundle.
deleteTaskType
Delete a task type.
deleteTask
Delete a task.
deleteTaxRate
Delete a tax rate.
deleteTemplate
Delete a template.
deleteTypeGroup
Delete a type group. Its types are kept and become ungrouped.
deleteUserAvatar
Delete the current user's avatar.
deleteUser
Delete a user.
deleteView
Delete a view.
deleteWebhook
Delete a webhook.
disableMfaEnforcement
Stop requiring two-factor authentication for the account. Account owner only. Takes a current code from the owner's authenticator app or one of their recovery codes; wrong codes count towards the same lockout as disableTotpAuthentication. Users who set it up keep it.
disableTotpAuthentication
Disable TOTP Authentication. Takes a current code or a recovery code. Wrong codes count towards the lockout shared with sign-in: every 10th wrong code in a row stops two-factor codes being accepted anywhere, for 15 minutes, then 1 hour, 4 hours and 24 hours. A right code resets the count; otherwise it is forgotten a day after the last wrong code.
disconnectExchangeConnection
Disconnect the authenticated user's Exchange mailbox.
disconnectIntegration
Disconnect an OAuth integration.
dispatchEInvoices
Dispatch invoices as e-invoices.
documentAction
Handle document actions (download/send).
duplicateAct
Duplicate an existing act.
duplicateContract
Duplicate an existing contract.
duplicateCoordination
Duplicate an existing coordination.
duplicateEasement
Duplicate an existing easement.
duplicateExpense
Duplicate an existing expense.
duplicateGovernanceDocument
Duplicate an existing governance document.
duplicateInvoice
Duplicate an existing invoice.
duplicateLetter
Duplicate an existing letter.
duplicateMeter
Duplicate an existing meter.
duplicateOrdinance
Use duplicateGovernanceDocument instead
duplicateProduct
Duplicate an existing product.
duplicateProject
Duplicate an existing project.
duplicateQuote
Duplicate an existing quote.
duplicateSpecification
Duplicate an existing specification.
duplicateSubmission
Duplicate an existing submission.
duplicateTask
Duplicate an existing task.
duplicateTemplate
Duplicate an existing template.
enableTotpAuthentication
Enable TOTP Authentication. Takes the user's current password.
enforceMfaForAccount
Require two-factor authentication for everyone in the account. Account owner only, and the owner must have it set up first. Users without it are limited to setting it up from their next request.
finalizeESigning
Finalize an e-signing and dispatch it for processing.
finalizeInvoice
Finalize the draft invoice. A normal invoice becomes UNPAID. A credit invoice becomes ISSUED once its total is negative and within the amount left to credit on the invoice it credits; issuing it requires permission to void and credit invoices and edit rights on that invoice. When nothing is left to credit afterwards, the credited invoice becomes CREDITED.
follow
Follow a given instance.
forgotPassword
No description
generateTotpRecoveryCodes
Generate TOTP Recovery Codes, replacing the whole set. Takes a current code from the authenticator app; recovery codes are not accepted. Wrong codes count towards the same lockout as disableTotpAuthentication.
initiateExchangeConnection
Begin the OAuth flow to connect the authenticated user's Exchange mailbox.
initiateOAuthIntegration
Initiate OAuth flow for an integration.
login
Login with username and password, with optional MFA support.
logout
No description
markDashboardAsDefault
Mark the given dashboard as default.
markExpenseAsPaid
Confirm the payment of an approved expense that is unpaid or scheduled. Its payment status becomes PAID; the workflow status stays APPROVED.
markExpenseAsUnpaid
Undo the payment confirmation of an approved expense. Its payment status returns to UNPAID and its payment date is cleared.
markInvoiceAsPaid
Mark the invoice as paid.
markInvoiceAsPartiallyPaid
Mark the invoice as partially paid.
markInvoiceAsUncollectible
Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
markNotificationAsRead
Mark a single notification as read.
markNotificationAsUnread
Mark a single notification as unread.
markNotificationsAsRead
Mark all of the notifications as read.
markNotificationsAsSeen
Mark all of the notifications as seen.
markViewAsDefault
Mark the given view as default.
permanentlyDeleteFromDeletedRecords
Permanently delete a deleted record.
recalculateExpenseAmounts
Stop keeping the amounts of an imported expense as the supplier's e-invoice stated them and compute every line from quantity times unit price instead. Only for a submitted expense whose every line has a tax rate. Requires the CANCHANGEEXPENSE_AMOUNTS permission.
refreshToken
No description
rejectApproval
Reject an approval as the current user.
remindApprovalApprover
Send a reminder to a pending approver.
remindESigningSignatory
Send a reminder to an e-signing signatory.
removeFollower
Remove a follower for a given instance.
reopenExpense
Send an approved expense that is not paid back to submitted, so it can be corrected and approved again. The reason is kept in the expense's activity log.
resendESigningSignatory
Resend signing request to an e-signing signatory.
resetPassword
No description
restoreActType
Restore a deleted act type.
restoreAct
Restore a deleted act.
restoreComment
Restore a deleted comment.
restoreCompany
Restore a deleted company.
restoreContact
Restore a deleted contact.
restoreContractType
Restore a deleted contract type.
restoreContract
Restore a deleted contract.
restoreCoordinationGroup
Restore a deleted coordination group.
restoreCoordinationStage
Restore a deleted coordination stage.
restoreCoordinationType
Restore a deleted coordination type.
restoreCoordination
Restore a deleted coordination.
restoreDashboard
Restore a deleted dashboard.
restoreDashlet
Restore a deleted dashlet.
restoreEasementType
Restore a deleted easement type.
restoreEasement
Restore a deleted easement.
restoreExpenseAmounts
Put the amounts of an imported expense back to what the supplier's e-invoice stated, undoing a recalculation. Only for a submitted expense. Requires the CANCHANGEEXPENSE_AMOUNTS permission.
restoreExpense
Restore a deleted expense.
restoreFile
Restore a deleted file.
restoreFromDeletedRecords
Restore a deleted record from the recycle bin (soft-deleted item).
restoreGovernanceDocumentType
Restore a deleted governance document type.
restoreGovernanceDocument
Restore a deleted governance document.
restoreInvoice
Restore a deleted invoice.
restoreLetterSource
Restore a deleted letter source.
restoreLetterType
Restore a deleted letter type.
restoreLetter
Restore a deleted letter.
restoreMeterManufacturer
Restore a deleted meter manufacturer.
restoreMeterModel
Restore a deleted meter model.
restoreMeterNominalValue
Restore a deleted meter nominal value.
restoreMeter
Restore a deleted meter.
restoreNumberingFunction
Restore a deleted numbering function.
restoreNumberingSeries
Restore a deleted numbering series.
restoreOrdinanceType
Use restoreGovernanceDocumentType instead
restoreOrdinance
Use restoreGovernanceDocument instead
restorePerson
Restore a deleted person.
restorePriceList
Restore a deleted price list.
restoreProductGroup
Restore a deleted product group.
restoreProduct
Restore a deleted product.
restoreProject
Restore a deleted project.
restoreProperty
Restore a deleted property.
restoreQuote
Restore a deleted quote.
restoreReading
Restore a deleted reading.
restoreRole
Restore a deleted role.
restoreSpecificationType
Restore a deleted specification type.
restoreSpecification
Restore a deleted specification.
restoreStatus
Restore a deleted status.
restoreSubmissionSource
Restore a deleted submission source.
restoreSubmissionType
Restore a deleted submission type.
restoreSubmission
Restore a deleted submission.
restoreTag
Restore a deleted tag.
restoreTaskBundle
Restore a deleted task bundle.
restoreTaskType
Restore a deleted task type.
restoreTask
Restore a deleted task.
restoreTaxRate
Restore a deleted tax rate.
restoreTemplate
Restore a deleted template.
restoreTypeGroup
Restore a deleted type group.
restoreUser
Restore a deleted user.
restoreView
Restore a deleted view.
restoreWebhook
Restore a deleted webhook.
revokeAccessToken
Revoke an access token.
revokeSession
Revoke access of the given session.
saveDataRetention
Save data retention config (morph => days).
saveSetting
Save a setting value.
scheduleExpensePayment
Hand an approved, unpaid expense to the agreed payment process. Its payment status becomes SCHEDULED until the payment is confirmed.
sendEmail
Email the picked recipients about a record, through the sender's connected Exchange mailbox or the tenant's SMTP server. A printout of the record and files already attached to it are optional attachments; an email without attachments is allowed. Needs view access to the record.
templateRender
Render (and optionally send) a PDF using user-picked manual relation node selections. Needs view access to the record, not the template-editing permission. SEND is deprecated, use sendEmail.
testExchangeConnection
Verify the authenticated user's Exchange mailbox connection is still usable.
unfollow
Unfollow a given instance.
updateAccessToken
Update an access token.
updateAccountAddress
Update the account's address details.
updateActType
Update an existing act type.
updateAct
Update an existing act.
updateApproval
Update an existing approval.
updateComment
Update an existing comment.
updateCompanyAddress
Update the company's address details.
updateCompanyEmails
Assign email addresses with the company. This will remove all existing entries.
updateCompanyLinkedins
Assign Linkedin with the company. This will remove all existing entries.
updateCompanyPhones
Assign phone numbers with the company. This will remove all existing entries.
updateCompanyWebsites
Assign websites with the company. This will remove all existing entries.
updateCompany
Update an existing company.
updateContactAddress
Update the contact's address details.
updateContactEmails
Assign email addresses with the contact. This will remove all existing entries.
updateContactLinkedins
Assign Linkedin with the contact. This will remove all existing entries.
updateContactMeansOfContact
Update a contact's single means of contact.
updateContactPhones
Assign phone numbers with the contact. This will remove all existing entries.
updateContactWebsites
Assign websites with the contact. This will remove all existing entries.
updateContact
Update an existing contact.
updateContractType
Update an existing contract type.
updateContract
Update an existing contract.
updateCoordinationGroup
Update an existing coordination group.
updateCoordinationStage
Update an existing coordination stage.
updateCoordinationType
Update an existing coordination type.
updateCoordination
Update an existing coordination.
updateDashboard
Update an existing dashboard.
updateDashlet
Update an existing dashlet.
updateEasementType
Update an existing easement type.
updateEasement
Update an existing easement.
updateESigning
Update an existing e-signing.
updateExpense
Update an existing expense.
updateGovernanceDocumentType
Update an existing governance document type.
updateGovernanceDocument
Update an existing governance document.
updateInvoice
Update an existing invoice.
updateLetterSource
Update an existing letter source.
updateLetterType
Update an existing letter type.
updateLetter
Update an existing letter.
updateMeterManufacturer
Update an existing meter manufacturer.
updateMeterModel
Update an existing meter model.
updateMeterNominalValue
Update an existing meter nominal value.
updateMeter
Update an existing meter.
updateNumberingFunction
Update an existing numbering function.
updateNumberingSeriesInstances
Update an existing numbering series' instances.
updateNumberingSeries
Update an existing numbering series.
updateOrdinanceType
Use updateGovernanceDocumentType instead
updateOrdinance
Use updateGovernanceDocument instead
updatePassword
Update a user's password.
updatePersonAddress
Update the person's address details.
updatePersonEmails
Assign email addresses with the person. This will remove all existing entries.
updatePersonLinkedins
Assign Linkedin with the person. This will remove all existing entries.
updatePersonPhones
Assign phone numbers with the person. This will remove all existing entries.
updatePersonWebsites
Assign websites with the person. This will remove all existing entries.
updatePerson
Update an existing person.
updatePriceList
Update an existing price list.
updateProductGroup
Update an existing product group.
updateProduct
Update an existing product.
updateProject
Update an existing project.
updatePropertyIntendedUses
Update the property's intended uses. This will remove all existing entries and replace with the current input.
updateProperty
Update an existing property.
updateQuote
Update an existing quote.
updateReading
Update an existing reading.
updateRoleModules
Update a role's modules.
updateRolePermissions
Update a role's permissions.
updateRole
Update an existing role.
updateSpecificationType
Update an existing specification type.
updateSpecification
Update an existing specification.
updateStatus
Update an existing status.
updateStatusesOrdering
Update statuses ordering.
updateStructure
Attach or detach relations on a structure. Structure scalar fields are sourced
updateSubmissionSource
Update an existing submission source.
updateSubmissionType
Update an existing submission type.
updateSubmission
Update an existing submission.
updateTag
Update an existing tag.
updateTaskBundle
Update an existing task bundle.
updateTaskRecurrence
Update an existing recurring template's schedule. Currently exposes endsAt only.
updateTaskType
Update an existing task type.
updateTask
Update an existing task.
updateTaxRate
Update an existing tax rate.
updateTemplate
Update an existing template.
updateTypeGroup
Update an existing type group.
updateTypesOrdering
Update the ordering of types within a module.
updateUserPhones
Assign phone numbers with the user. This will remove all existing entries.
updateUserRoles
Update the user's roles.
updateUser
Update an existing user.
updateView
Update an existing view.
updateWebhook
Update an existing webhook.
uploadAccountLogo
Upload the account's logo.
uploadFile
Upload a file.
uploadUserAvatar
Upload the current user's avatar.
voidExpense
Mark an expense as void. This cannot be undone. Voiding an expense is similar to deletion, however it maintains a paper trail where the expense can still be found. Allowed on a submitted expense and on an approved one that is not paid. Requires the CANVOIDEXPENSES permission.
voidInvoice
Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.