# Fidly API

> Read and write the accounting data of a company through a stable HTTP interface.

## English

### Guides

#### Getting started

- [Introduction](https://api-doc.fidly.be/en/introduction.md): Read and write a company's data over a stable HTTP interface.
- [Sandbox](https://api-doc.fidly.be/en/sandbox.md): Test your integration against fixtures, with the exact validations of live.
- [Authentication](https://api-doc.fidly.be/en/authentication.md): OAuth2 client credentials, access token lifetime, refresh rotation and permissions.
- [Conventions](https://api-doc.fidly.be/en/conventions.md): The principles that hold on every endpoint: request body and query parameters, reading fields, creating and updating.
- [Pagination and filters](https://api-doc.fidly.be/en/pagination.md): How lists and filters behave across the whole API.
- [Errors](https://api-doc.fidly.be/en/errors.md): One envelope for every error, with a machine-readable code, grouped by resource.
- [Changelog](https://api-doc.fidly.be/en/changelog.md): Notable changes to the Fidly API, most recent first.

#### Resources

- [Documents](https://api-doc.fidly.be/en/concepts/documents.md): Invoices, credit notes and received documents: read, issue, correct, send, import.
- [Relations](https://api-doc.fidly.be/en/concepts/relations.md): The third parties of the company: companies and individual contacts, unified.
- [Delivery locations](https://api-doc.fidly.be/en/concepts/delivery-locations.md): Addresses registered on a relation, reusable on its documents.
- [Bank accounts](https://api-doc.fidly.be/en/concepts/bank-accounts.md): The company's bank accounts: read them, create manual ones, manage the default.
- [Journals](https://api-doc.fidly.be/en/concepts/journals.md): The company's accounting journals: categories, numbering formats, defaults.
- [Brandings](https://api-doc.fidly.be/en/concepts/brandings.md): The company's visual identities: read them and choose the default one.
- [Reference lists](https://api-doc.fidly.be/en/concepts/reference-lists.md): Units, currencies and countries: fill a document or an address without hardcoding.

### API Reference

#### auth

- [Token](https://api-doc.fidly.be/api-reference/auth/token.md)

#### documents

- [List Documents](https://api-doc.fidly.be/api-reference/documents/list-documents.md)
- [Create Document](https://api-doc.fidly.be/api-reference/documents/create-document.md): Issue a document: a sale/purchase invoice, a credit note or a proforma.
- [Send Document](https://api-doc.fidly.be/api-reference/documents/send-document.md): Put a document the company issued on the Peppol network (droit `document:u`).
- [Get Document](https://api-doc.fidly.be/api-reference/documents/get-document.md)
- [Delete Document](https://api-doc.fidly.be/api-reference/documents/delete-document.md): Delete a document the company issued (droit `document:d`). Definitive.
- [Update Document](https://api-doc.fidly.be/api-reference/documents/update-document.md): Correct a document the company issued, as long as it has **gone nowhere yet**.
- [Add Document Attachments](https://api-doc.fidly.be/api-reference/documents/add-document-attachments.md): Attach one or more files to a document the company issued (droit `document:u`).
- [Get Document File](https://api-doc.fidly.be/api-reference/documents/get-document-file.md)
- [Import Document](https://api-doc.fidly.be/api-reference/documents/import-document.md): Import a document (the API equivalent of dropping a file in the interface).

#### relations

- [List Relations](https://api-doc.fidly.be/api-reference/relations/list-relations.md)
- [Create Relation](https://api-doc.fidly.be/api-reference/relations/create-relation.md): Create a third party of the company: a business (`type: company`) or an individual (`type: contact`).
- [Get Relation](https://api-doc.fidly.be/api-reference/relations/get-relation.md)
- [Delete Relation](https://api-doc.fidly.be/api-reference/relations/delete-relation.md): Delete a third party. For good — Fidly has no archived state to fall back on.
- [Update Relation](https://api-doc.fidly.be/api-reference/relations/update-relation.md): Update the editable fields of a relation.

#### delivery locations

- [List Delivery Locations](https://api-doc.fidly.be/api-reference/delivery-locations/list-delivery-locations.md): The delivery addresses saved on the company's third parties.
- [Create Delivery Location](https://api-doc.fidly.be/api-reference/delivery-locations/create-delivery-location.md): Save a delivery address on a third party, to reuse it on the documents issued to it.
- [Get Delivery Location](https://api-doc.fidly.be/api-reference/delivery-locations/get-delivery-location.md)
- [Delete Delivery Location](https://api-doc.fidly.be/api-reference/delivery-locations/delete-delivery-location.md): Delete a saved delivery address.
- [Update Delivery Location](https://api-doc.fidly.be/api-reference/delivery-locations/update-delivery-location.md): Update a delivery address.

#### bank accounts

- [List Bank Accounts](https://api-doc.fidly.be/api-reference/bank-accounts/list-bank-accounts.md)
- [Create Bank Account](https://api-doc.fidly.be/api-reference/bank-accounts/create-bank-account.md): Declare a bank account of the company.
- [Get Bank Account](https://api-doc.fidly.be/api-reference/bank-accounts/get-bank-account.md)
- [Update Bank Account](https://api-doc.fidly.be/api-reference/bank-accounts/update-bank-account.md): Update the editable fields of a bank account.

#### journals

- [List Journals](https://api-doc.fidly.be/api-reference/journals/list-journals.md)
- [Create Journal](https://api-doc.fidly.be/api-reference/journals/create-journal.md): Create an accounting journal of the company.
- [Get Journal](https://api-doc.fidly.be/api-reference/journals/get-journal.md)
- [Update Journal](https://api-doc.fidly.be/api-reference/journals/update-journal.md): Update the editable fields of a journal.

#### brandings

- [List Brandings](https://api-doc.fidly.be/api-reference/brandings/list-brandings.md): List the company's brandings, the default one first.
- [Get Branding](https://api-doc.fidly.be/api-reference/brandings/get-branding.md)
- [Update Branding](https://api-doc.fidly.be/api-reference/brandings/update-branding.md): Make this branding the one the company's documents are rendered with.

#### reference

- [List Units Of Measure](https://api-doc.fidly.be/api-reference/reference/list-units-of-measure.md): The units of measure a document line's `quantity` can be expressed in.
- [List Currencies](https://api-doc.fidly.be/api-reference/reference/list-currencies.md): The currencies a document's amounts can be expressed in.
- [List Countries](https://api-doc.fidly.be/api-reference/reference/list-countries.md): The country codes accepted in a relation's `address.country_code`.

#### health

- [Health](https://api-doc.fidly.be/api-reference/health/health.md)

## OpenAPI Specs

- [openapi](/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [French (49 pages)](https://api-doc.fidly.be/_llms/fr.md): Documentation for French.