ㅤReading time – 6 minutes
ㅤFinmap
ㅤ
General information 🖇️
ㅤAPI (Application Programming Interface) — is a set of ready-made classes, procedures, functions, structures, and constants provided by an application (library, service) for use in external software products. The API acts as an intermediary between the application developer and any environment with which the application must interact.
ㅤFinmap has an open API that can be used by users for their own needs and to customize individual integrations with the service. You can view information on the API in the section Settings – Company settings, block – Developers. Here you will find information about the API documentation.
📎 Or you can find it here: https://api.finmap.online/
ㅤ
ㅤThe API key is an encryption key for user authentication in the system, similar to a login and password.
ㅤFinmap API documentation is based on the Swagger resource
ㅤ
Blocks in ARI documentation 📁
ㅤ
ㅤThe documentation is divided into blocks:
- webhooks – a block that helps to work with webhooks
- default – general functionality check
- currencies – shows in which currency you can open a company
- accounts – work with accounts
- tags – work with tags
- projects – work with projects
- categories/income – work with income categories
- categories/expense – work with expense categories
- customers – work with clients
- investors – work with investors
- creditors – work with creditors
- debitors – work with borrowers
- suppliers – work with suppliers
- employees – work with employees
- owners – work with owners
- operations/income – work with revenue transactions
- operations/expense – work with expense transactions
- operations/transfer – work with transfers
ㅤ
ㅤ
ㅤFor certain blocks, you can view, edit, delete, and add. These blocks include:
- tags
- projects
- categories/income
- categories/expense
- customers
- investors
- creditors
- debitors
- suppliers
- employees
- owners
ㅤ
ㅤ
ㅤThrough the following blocks, you can only add operations. They include:
- operations/income
- operations/expense
- operations/transfer
ㅤ
❌ The exception is the accounts block; through this block, you can only receive information about which accounts are in the service
ㅤ
ㅤㅤ
Query methods ⚙️
ㅤ
- GET — used to get or read data. Requests using this method can only retrieve data.
- PATCH — is usually used to update a resource by replacing the request data.
- POST — is usually used to create a new resource, and no one will see this information after you send it.
- DELETE — deletes data.