Orçamentos & gastos

Orçamentos, transações, custos, impostos e contas bancárias — acompanhe as despesas e reconcilie automaticamente.

Orçamento

Endpoints

GET	/budgets	Recupera a coleção de recursos Budget.
POST	/budgets	Cria um recurso Budget.
GET	/budgets/{id}	Recupera um recurso Budget.
PATCH	/budgets/{id}	Atualiza o recurso Budget.
DELETE	/budgets/{id}	Remove o recurso Budget.
POST	/budgets/{id}/copy-plan-from-year	Cria um recurso Budget.
GET	/budgets/{id}/employee-pnl	Recupera um recurso Budget.
PUT	/budgets/{id}/plan	Substitui o recurso Budget.
GET	/budgets/{id}/pnl-by-tags	Recupera um recurso Budget.
GET	/budgets/{id}/pnl-by-tags-drilldown	Recupera um recurso Budget.

Campos de schema

Campo	Tipo	Descrição
name*	string
type*	string
granularity	string
budgetGroup	string,null (iri-reference)
attributeSet	string,null (iri-reference)
dateFrom	string,null (date-time)
dateTo	string,null (date-time)
displayPricePerSqm	boolean	Opt-in flag for the P&L-by-tags preview's price-per-sqm column. When true, the costsByProject section is expected to surface a surface-aware price view in addition to absolute amounts. The actual surface lookup (Project -> assigned Property/Asset -> surface AttributeValue) lands after the post-Horizon-2026-04-30 co-design pass; this flag is the persistent toggle so the option exists today.
outgoingTags	array	Tag-mode filter (outgoing/income side). OR semantics — an invoice matches if it carries at least one of these tags. Replaces the legacy single $outgoingTag ManyToOne (kept as a virtual property for backwards-compat during the FE rollout window).
incomingTags	array
amountStrategy*	string
actualMode	string
planningMode	stringnull
viewMode	stringnull	Explicit planning-vs-observation intent, decoupled from planningMode (the scope). Null on legacy budgets: BudgetNormalizer::resolveViewMode() falls back to inferring the mode from plan artifacts when this is unset, so existing budgets are unchanged. Write-only groups — the read value is emitted by BudgetNormalizer, which honours this field first.
planSource	string
config	array
includePeopleCosts	booleannull
includeEmployeeCosts	booleannull
includePeopleIncome	booleannull
outgoingTag	string,null (iri-reference)	Legacy single-tag alias — read returns the first element of $outgoingTags (or null). Write REPLACES the collection with a single-element array (or empty when null). Exists only to keep the still-deployed old frontend working through PR 3's rollout.
incomingTag	string,null (iri-reference)

Transação do Orçamento

Endpoints

GET	/budget-transactions	Recupera a coleção de recursos BudgetTransaction.
POST	/budget-transactions	Cria um recurso BudgetTransaction.
GET	/budget-transactions/{id}	Recupera um recurso BudgetTransaction.
PATCH	/budget-transactions/{id}	Atualiza o recurso BudgetTransaction.
DELETE	/budget-transactions/{id}	Remove o recurso BudgetTransaction.

Campos de schema

Campo	Tipo	Descrição
budget*	string (iri-reference)
transaction*	string (iri-reference)
employee	string,null (iri-reference)
amount	numbernull

Grupo de Orçamento

Endpoints

GET	/budget-groups	Recupera a coleção de recursos BudgetGroup.
POST	/budget-groups	Cria um recurso BudgetGroup.
GET	/budget-groups/{id}	Recupera um recurso BudgetGroup.
PATCH	/budget-groups/{id}	Atualiza o recurso BudgetGroup.
DELETE	/budget-groups/{id}	Remove o recurso BudgetGroup.

Campos de schema

Campo	Tipo	Descrição
name*	string

Custo

Endpoints

GET	/contractors	Recupera a coleção de recursos Cost.
POST	/contractors	Cria um recurso Cost.
GET	/contractors/{id}	Recupera um recurso Cost.
PATCH	/contractors/{id}	Atualiza o recurso Cost.
DELETE	/contractors/{id}	Remove o recurso Cost.
POST	/contractors/nip-validation	Cria um recurso Cost.
GET	/contractors/search	Recupera a coleção de recursos Cost.
GET	/costs	Recupera a coleção de recursos Cost.
POST	/costs	Cria um recurso Cost.
GET	/costs/{id}	Recupera um recurso Cost.
PATCH	/costs/{id}	Atualiza o recurso Cost.
GET	/costs/{id}/documents	Recupera um recurso Cost.
GET	/costs/payment-due/{date}	Get by path parameters
GET	/suppliers	Recupera a coleção de recursos Cost.
POST	/suppliers	Cria um recurso Cost.
GET	/suppliers/{id}	Recupera um recurso Cost.
PATCH	/suppliers/{id}	Atualiza o recurso Cost.
DELETE	/suppliers/{id}	Remove o recurso Cost.
POST	/suppliers/nip-validation	Cria um recurso Cost.
GET	/suppliers/search	Recupera a coleção de recursos Cost.

Campos de schema

Campo	Tipo	Descrição
costGroup*	string (iri-reference)
allowDuplicate	booleannull	Not persisted (no ORM\Column): an escape hatch for POST /contractors only, mirroring Client::$allowDuplicate. When true, ContractorCreateProcessor:: refuseIfDuplicate() skips the duplicate-party guard so a genuinely distinct same-name contractor can be created on purpose.
ownerEmployee	string,null (iri-reference)
tinType*	string
tin	stringnull
tinCountry	string,null (iri-reference)
cyclic	boolean
paymentDeadline	integernull
name*	string
description	stringnull
matchRegex	stringnull
requireAttachment	booleannull
taxAmount	stringnull
notIncludeInChart	boolean
eInvoicingReferenceNumber	stringnull
eInvoicingSourceXmlUrl	stringnull
eInvoicingVisualUrl	stringnull
contractorGroup	string,null (iri-reference)

Transação

Endpoints

GET	/transactions	Recupera a coleção de recursos Transaction.
POST	/transactions	Cria um recurso Transaction.
GET	/transactions/{id}	Recupera um recurso Transaction.
PATCH	/transactions/{id}	Atualiza o recurso Transaction.
DELETE	/transactions/{id}	Remove o recurso Transaction.
GET	/transactions/{id}/suggestions	Recupera a coleção de recursos Transaction.
POST	/transactions/{id}/suggestions/{suggestionId}/apply	Cria um recurso Transaction.
POST	/transactions/import	Cria um recurso Transaction.
GET	/transactions/search	Recupera a coleção de recursos Transaction.
GET	/transactions/unassigned	Recupera a coleção de recursos Transaction.
GET	/transactions/with-problems	Recupera a coleção de recursos Transaction.

Campos de schema

Campo	Tipo	Descrição
id	string
bankAccount	string (iri-reference)
employeeOwner	string,null (iri-reference)
hash	string
source	stringnull	Where this row came from. Written at creation by whichever importer or creator made it — NEVER inferred from the row's shape.
type	string
cost	string,null (iri-reference)
counterparty	string,null (iri-reference)
counterpartyRole	stringnull
statementNumber	integer
operationNumber	stringnull
description	string
currency	string
amount	number
endingBalance	number
orderDate	string (date-time)
execDate	string (date-time)
relatedDate	string,null (date-time)
ignored*	integer
note	stringnull
hasDetectedProblems	booleannull
transactionAttachments	array
additionalAttachments	array	Inverse of TransactionAttachment.additionalTransactions: invoice documents this transaction is linked to as an ADDITIONAL payment (one invoice paid across several payments). Lets the transaction recognize the link for completeness, same as a primary attachment.
invoiceTransactions	array
properties	array
budgetTransactions	array
projectTransactions	array
employeeTransactions	array
createdAt	string (date-time)
updatedAt	string (date-time)
contractor	string,null (iri-reference)
connectedMonth	string (date-time)
relatedEmployee	string,null (iri-reference)

Conta Bancária

Endpoints

GET	/bank-accounts	Recupera a coleção de recursos BankAccount.
POST	/bank-accounts	Cria um recurso BankAccount.
GET	/bank-accounts/{id}	Recupera um recurso BankAccount.
PATCH	/bank-accounts/{id}	Atualiza o recurso BankAccount.

Campos de schema

Campo	Tipo	Descrição
bank	string,null (iri-reference)
type*	string
default	boolean
hidden	boolean
name*	string
number	stringnull
prefix	stringnull
currency*	string,null (iri-reference)
defaultImportFormat*	string

Grupo Fiscal

Endpoints

GET	/tax-groups	Recupera a coleção de recursos TaxGroup.
POST	/tax-groups	Cria um recurso TaxGroup.
GET	/tax-groups/{id}	Recupera um recurso TaxGroup.
PATCH	/tax-groups/{id}	Atualiza o recurso TaxGroup.

Campos de schema

Campo	Tipo	Descrição
name*	string
isDefault	boolean

Moeda

Endpoints

GET	/currencies	Recupera a coleção de recursos Currency.
GET	/currencies/{!sourceCurrency}/rates/{!targetCurrency}/{date}	Recupera a coleção de recursos Currency.
GET	/currencies/{id}	Recupera um recurso Currency.

Campos de schema

Campo	Tipo	Descrição
id*	string

Orçamento Inicial

Endpoints

GET	/initial-budgets	Recupera a coleção de recursos InitialBudget.
POST	/initial-budgets	Cria um recurso InitialBudget.
GET	/initial-budgets/{id}	Recupera um recurso InitialBudget.
PATCH	/initial-budgets/{id}	Atualiza o recurso InitialBudget.
DELETE	/initial-budgets/{id}	Remove o recurso InitialBudget.
GET	/initial-budgets/{id}/contract-comparison	Recupera um recurso InitialBudget.
GET	/initial-budgets/{id}/contract-comparison/{tagDefinitionId}/breakdown	Recupera um recurso InitialBudget.

Campos de schema

Campo	Tipo	Descrição
project	string (iri-reference)
name	string
notes	stringnull

Item de Orçamento Inicial

Endpoints

GET	/initial-budget-items	Recupera a coleção de recursos InitialBudgetItem.
POST	/initial-budget-items	Cria um recurso InitialBudgetItem.
GET	/initial-budget-items/{id}	Recupera um recurso InitialBudgetItem.
PATCH	/initial-budget-items/{id}	Atualiza o recurso InitialBudgetItem.
DELETE	/initial-budget-items/{id}	Remove o recurso InitialBudgetItem.

Campos de schema

Campo	Tipo	Descrição
id	string
name	string
plannedAmount	stringnull
tagDefinition	string,null (iri-reference)
unit	stringnull
quantity	stringnull
sortOrder	integer

Período de Orçamento

Endpoints

GET	/budget-periods	Recupera a coleção de recursos BudgetPeriod.
POST	/budget-periods	Cria um recurso BudgetPeriod.
GET	/budget-periods/{id}	Recupera um recurso BudgetPeriod.
PATCH	/budget-periods/{id}	Atualiza o recurso BudgetPeriod.
DELETE	/budget-periods/{id}	Remove o recurso BudgetPeriod.

Campos de schema

Campo	Tipo	Descrição
id	string
periodKey	string
baseAmount	stringnull
linearGrowth	stringnull
exponentialGrowthBps	integernull
unitGrowth	stringnull
plannedIncome	stringnull

Colaborador do Orçamento

Endpoints

GET	/budget-employees	Recupera a coleção de recursos BudgetEmployee.
POST	/budget-employees	Cria um recurso BudgetEmployee.
GET	/budget-employees/{id}	Recupera um recurso BudgetEmployee.
PATCH	/budget-employees/{id}	Atualiza o recurso BudgetEmployee.
DELETE	/budget-employees/{id}	Remove o recurso BudgetEmployee.

Campos de schema

Campo	Tipo	Descrição
id	string
budget*	object
employee*	string (iri-reference)
position	string
positionName	string

Contrato do Orçamento

Endpoints

GET	/budget-contracts	Recupera a coleção de recursos BudgetContract.
POST	/budget-contracts	Cria um recurso BudgetContract.
GET	/budget-contracts/{id}	Recupera um recurso BudgetContract.
DELETE	/budget-contracts/{id}	Remove o recurso BudgetContract.

Campos de schema

Campo	Tipo	Descrição
id	string
contract	string (iri-reference)

Fornecedor do Orçamento

Endpoints

GET	/budget-contractors	Recupera a coleção de recursos BudgetContractor.
POST	/budget-contractors	Cria um recurso BudgetContractor.
GET	/budget-contractors/{id}	Recupera um recurso BudgetContractor.
DELETE	/budget-contractors/{id}	Remove o recurso BudgetContractor.

Campos de schema

Campo	Tipo	Descrição
budget*	string (iri-reference)
contractor*	string (iri-reference)

Fatura do Orçamento

Endpoints

GET	/budget-invoices	Recupera a coleção de recursos BudgetInvoice.
POST	/budget-invoices	Cria um recurso BudgetInvoice.
GET	/budget-invoices/{id}	Recupera um recurso BudgetInvoice.
DELETE	/budget-invoices/{id}	Remove o recurso BudgetInvoice.

Campos de schema

Campo	Tipo	Descrição
budget*	string (iri-reference)
invoice*	string (iri-reference)
amountNet	stringnull

Projeto do Orçamento

Endpoints

GET	/budget-projects	Recupera a coleção de recursos BudgetProject.
POST	/budget-projects	Cria um recurso BudgetProject.
GET	/budget-projects/{id}	Recupera um recurso BudgetProject.
DELETE	/budget-projects/{id}	Remove o recurso BudgetProject.

Campos de schema

Campo	Tipo	Descrição
id	string
budget*	object
project*	string (iri-reference)
createdAt	string (date-time)

Item de Atividade do Orçamento

Endpoints

GET

/budget-activity

Campos de schema

Campo	Tipo	Descrição
type	string
state	string
direction	string
label	string
amount	number
date	stringnull

Item de Alerta do Orçamento

Endpoints

GET

/budget-alerts

Campos de schema

Campo	Tipo	Descrição
key	string
type	string
severity	string
title	string
description	string
period	stringnull
dismissed	boolean

Grupo de Custos

Endpoints

GET	/cost-groups	Recupera a coleção de recursos CostGroup.
POST	/cost-groups	Cria um recurso CostGroup.
GET	/cost-groups/{id}	Get cost group chart
PATCH	/cost-groups/{id}	Atualiza o recurso CostGroup.
GET	/cost-groups/{id}/chart	Get cost group chart
POST	/cost-groups/{id}/merge	Merge cost groups
POST	/cost-groups/assign-icons-ai	Assign cost group icons via AI
GET	/cost-groups/chart	Get cost groups chart

Campos de schema

Campo	Tipo	Descrição
id	integer
type*	string
name*	string
description	stringnull
icon	stringnull
accoutancy_reference	stringnull
costs	array
createdAt	string (date-time)
updatedAt	string (date-time)
possibleTypes	string

Regra Fiscal

Endpoints

GET	/tax-rules	Recupera a coleção de recursos TaxRule.
POST	/tax-rules	Cria um recurso TaxRule.
GET	/tax-rules/{id}	Recupera um recurso TaxRule.
PATCH	/tax-rules/{id}	Atualiza o recurso TaxRule.
DELETE	/tax-rules/{id}	Remove o recurso TaxRule.

Campos de schema

Campo	Tipo	Descrição
id	string
country*	string (iri-reference)
taxAmount*	string

Banco

Endpoints

GET	/banks	Recupera a coleção de recursos Bank.
POST	/banks	Cria um recurso Bank.
GET	/banks/{id}	Recupera um recurso Bank.
PATCH	/banks/{id}	Atualiza o recurso Bank.

Campos de schema

Campo	Tipo	Descrição
name	string
swift*	string

Anexo de Transação

Endpoints

GET	/transaction-attachments	Recupera a coleção de recursos TransactionAttachment.
POST	/transaction-attachments	Cria um recurso TransactionAttachment.
GET	/transaction-attachments/{id}	Recupera um recurso TransactionAttachment.
PATCH	/transaction-attachments/{id}	Atualiza o recurso TransactionAttachment.
DELETE	/transaction-attachments/{id}	Remove o recurso TransactionAttachment.
POST	/transaction-attachments/{id}/apply-suggestion	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/apply-supplier-suggestion	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/approve	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/cascade-preview	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/detach	Cria um recurso TransactionAttachment.
GET	/transaction-attachments/{id}/documents	Recupera um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/manual-match	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/mark-manual-paid	Cria um recurso TransactionAttachment.
GET	/transaction-attachments/{id}/match-candidates	Recupera a coleção de recursos TransactionAttachment.
POST	/transaction-attachments/{id}/prefill-project-allocations	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/prefill-project-allocations-by-cascade	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/prefill-project-allocations-by-meter	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/reject	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/replace-project-allocations	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/settle-without-transaction	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/submit-for-approval	Cria um recurso TransactionAttachment.
GET	/transaction-attachments/{id}/suggestions	Recupera a coleção de recursos TransactionAttachment.
GET	/transaction-attachments/{id}/suggestions-debug	Recupera um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/suggestions/{suggestionId}/apply	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/suggestions/accept-all	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/unlink-transaction	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/unmark-manual-paid	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/unsettle-without-transaction	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/{id}/withdraw-approval	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/create	Cria um recurso TransactionAttachment.
POST	/transaction-attachments/create-base64	Cria um recurso TransactionAttachment.
GET	/transaction-attachments/pending-approval	Recupera a coleção de recursos TransactionAttachment.
GET	/transaction-attachments/search	Recupera a coleção de recursos TransactionAttachment.

Campos de schema

Campo	Tipo	Descrição
id	integer
amount	integernull
name	string	The DISPLAY name — the filename the user uploaded (#3381).
invoiceNumber	stringnull	The purchase document number, when one is known (#3381).
receivedAt	string (date-time)
status	string

Linha de Fatura do Anexo de Transação

Endpoints

POST	/transaction-attachment-invoice-lines	Cria um recurso TransactionAttachmentInvoiceLine.
PATCH	/transaction-attachment-invoice-lines/{id}	Atualiza o recurso TransactionAttachmentInvoiceLine.
DELETE	/transaction-attachment-invoice-lines/{id}	Remove o recurso TransactionAttachmentInvoiceLine.

Campos de schema

Campo	Tipo	Descrição
id	integer
transactionAttachment	string (iri-reference)
position	integer
description	stringnull
quantity	stringnull
unitPrice	stringnull
amount	stringnull
taxRate	stringnull
currency	stringnull
project	string,null (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)