← Référence API
Budgets et dépenses
Budgets, transactions, coûts et comptes bancaires — suivez les dépenses et rapprochez automatiquement.
Budget
Points de terminaison
| GET | /budgets | Retrieves the collection of Budget resources. |
| POST | /budgets | Creates a Budget resource. |
| GET | /budgets/{id} | Retrieves a Budget resource. |
| PATCH | /budgets/{id} | Updates the Budget resource. |
| DELETE | /budgets/{id} | Removes the Budget resource. |
| POST | /budgets/{id}/copy-plan-from-year | Creates a Budget resource. |
| GET | /budgets/{id}/employee-pnl | Retrieves a Budget resource. |
| PUT | /budgets/{id}/plan | Replaces the Budget resource. |
| GET | /budgets/{id}/pnl-by-tags | Retrieves a Budget resource. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| 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 surf |
| 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 ba |
| incomingTags | array | |
| amountStrategy* | string | |
| actualMode | string | |
| planningMode | stringnull | |
| 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-deplo |
| incomingTag | string,null (iri-reference) |
Transaction de budget
Points de terminaison
| GET | /budget-transactions | Retrieves the collection of BudgetTransaction resources. |
| POST | /budget-transactions | Creates a BudgetTransaction resource. |
| GET | /budget-transactions/{id} | Retrieves a BudgetTransaction resource. |
| PATCH | /budget-transactions/{id} | Updates the BudgetTransaction resource. |
| DELETE | /budget-transactions/{id} | Removes the BudgetTransaction resource. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| budget* | string (iri-reference) | |
| transaction* | string (iri-reference) | |
| employee | string,null (iri-reference) | |
| amount | numbernull |
Groupe de budget
Points de terminaison
| GET | /budget-groups | Retrieves the collection of BudgetGroup resources. |
| POST | /budget-groups | Creates a BudgetGroup resource. |
| GET | /budget-groups/{id} | Retrieves a BudgetGroup resource. |
| PATCH | /budget-groups/{id} | Updates the BudgetGroup resource. |
| DELETE | /budget-groups/{id} | Removes the BudgetGroup resource. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| name* | string |
Coût
Points de terminaison
| GET | /contractors | Retrieves the collection of Cost resources. |
| POST | /contractors | Creates a Cost resource. |
| GET | /contractors/{id} | Retrieves a Cost resource. |
| PATCH | /contractors/{id} | Updates the Cost resource. |
| DELETE | /contractors/{id} | Removes the Cost resource. |
| POST | /contractors/nip-validation | Creates a Cost resource. |
| GET | /contractors/search | Retrieves the collection of Cost resources. |
| GET | /costs | Retrieves the collection of Cost resources. |
| POST | /costs | Creates a Cost resource. |
| GET | /costs/{id} | Retrieves a Cost resource. |
| PATCH | /costs/{id} | Updates the Cost resource. |
| GET | /costs/{id}/documents | Retrieves a Cost resource. |
| GET | /costs/payment-due/{date} | Get by path parameters |
| GET | /suppliers | Retrieves the collection of Cost resources. |
| POST | /suppliers | Creates a Cost resource. |
| GET | /suppliers/{id} | Retrieves a Cost resource. |
| PATCH | /suppliers/{id} | Updates the Cost resource. |
| DELETE | /suppliers/{id} | Removes the Cost resource. |
| POST | /suppliers/nip-validation | Creates a Cost resource. |
| GET | /suppliers/search | Retrieves the collection of Cost resources. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| costGroup* | string (iri-reference) | |
| 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) |
Transaction
Points de terminaison
| GET | /transactions | Retrieves the collection of Transaction resources. |
| POST | /transactions | Creates a Transaction resource. |
| GET | /transactions/{id} | Retrieves a Transaction resource. |
| PATCH | /transactions/{id} | Updates the Transaction resource. |
| DELETE | /transactions/{id} | Removes the Transaction resource. |
| GET | /transactions/{id}/suggestions | Retrieves the collection of Transaction resources. |
| POST | /transactions/{id}/suggestions/{suggestionId}/apply | Creates a Transaction resource. |
| POST | /transactions/import | Creates a Transaction resource. |
| GET | /transactions/search | Retrieves the collection of Transaction resources. |
| GET | /transactions/unassigned | Retrieves the collection of Transaction resources. |
| GET | /transactions/with-problems | Retrieves the collection of Transaction resources. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id | string | |
| bankAccount | string (iri-reference) | |
| employeeOwner | string,null (iri-reference) | |
| hash | string | |
| 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 recog |
| 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) |
Compte bancaire
Points de terminaison
| GET | /bank-accounts | Retrieves the collection of BankAccount resources. |
| POST | /bank-accounts | Creates a BankAccount resource. |
| GET | /bank-accounts/{id} | Retrieves a BankAccount resource. |
| PATCH | /bank-accounts/{id} | Updates the BankAccount resource. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| bank | string,null (iri-reference) | |
| type* | string | |
| default | boolean | |
| hidden | boolean | |
| name* | string | |
| number | stringnull | |
| prefix | stringnull | |
| currency* | string,null (iri-reference) | |
| defaultImportFormat* | string |
Groupe fiscal
Points de terminaison
| GET | /tax-groups | Retrieves the collection of TaxGroup resources. |
| POST | /tax-groups | Creates a TaxGroup resource. |
| GET | /tax-groups/{id} | Retrieves a TaxGroup resource. |
| PATCH | /tax-groups/{id} | Updates the TaxGroup resource. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| name* | string | |
| isDefault | boolean |
Devise
Points de terminaison
| GET | /currencies | Retrieves the collection of Currency resources. |
| GET | /currencies/{!sourceCurrency}/rates/{!targetCurrency}/{date} | Retrieves the collection of Currency resources. |
| GET | /currencies/{id} | Retrieves a Currency resource. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id* | string | |
| name* | string |