Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
Service User · Connector Profile
Uses an Embat service user’s email and password, exchanged for a JWT bearer token that expires after 60 minutes and is r…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Service User · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
59 actions
Action
Description
List Accounting Accounts
Returns the accounting accounts (chart of accounts) of a company, including deactivated ones.
List Attributes
Returns all attributes configured for a company, including their
values when the attribute is of type list.Create Attribute
Creates an attribute. If
customId is omitted, Embat auto-generates one.Update Attributes In Bulk
Updates several attributes in a single call, following the same rules as the single attribute update endpoint.
Delete Attributes In Bulk
Deletes several attributes in a single call, following the same rules as the single attribute deletion endpoint.
Retrieve Attribute
Returns a single attribute by
customId.Update Attribute
Updates an attribute identified by
customId.Delete Attribute
Deletes an attribute by
customId, together with all of its values, and clears the parentId/parentCustomId of any a…Create Attributes In Bulk
Creates several attributes in a single call, following the same rules as the single attribute creation endpoint (upsert…
Add Values To An Attribute
Adds values to an existing attribute, identified by
customId, without affecting its other values.Remove Values From An Attribute
Removes one or more values from an attribute, identified by
customId.List Balances
Returns the end-of-day balances of a company’s bank products (accounts), one entry per product per day.
Retrieve Balance
Returns a single balance by its Embat
id.List Banks
Returns the company’s bank relationships.
Retrieve Bank
Returns a single bank relationship by its Embat
id.List Categories
Returns every category configured for the company, both top-level and child categories.
Retrieve Category
Returns a single category by its Embat
id.List User Companies
Returns the companies your credentials have access to.
Retrieve Company
Returns the detail of a company, including legal name, administrative contact, tags and configuration.
List Company Users
Returns the users with access to the company identified by
companyId.List Contacts
Returns the contacts (clients/suppliers) of a company.
Create Contact
Creates a contact (client/supplier). If
customId is omitted, Embat auto-generates one.Update Contacts In Bulk
Updates several contacts in a single call, identified by
customId.Delete Contacts In Bulk
Deletes several contacts in a single call, identified by
customId.Retrieve Contact
Returns a single contact by
customId.Update Contact
Updates a contact identified by
customId.Delete Contact
Deletes a contact by
customId. If customId does not match any contact, the call returns 404.Create Contacts In Bulk
Creates several contacts in a single call, following the same rules as the single contact creation endpoint: a `customId…
List Foreign Exchange Rates
Returns the daily foreign exchange rates recorded in Embat, most recent first, recalculated to be expressed against `bas…
Retrieve Foreign Exchange Rate
Returns a single foreign exchange rate record by
id, always expressed against EUR — the baseCurrency conversion avai…List Operations
Returns the operations of a company. By default only the operations created through this API are returned (`generatedFro…
Create Operation
Creates an operation (invoice/bill) with an optional
customId; if omitted, Embat auto-generates one.Update Operations In Bulk
Updates several operations in a single call, identified by
customId.Delete Operations In Bulk
Cancels several operations in a single call, identified by
customId, following the same rules as the single delete end…Retrieve Operation
Returns a single operation by
customId.Update Operation
Updates an operation identified by
customId.Delete Operation
Cancels an operation by
customId: its status is set to cancel and its pending amounts to 0.Create Operations In Bulk
Creates several operations in a single call, following the same rules as the single operation creation endpoint.
Add Internal Attributes To Operations In Bulk
Attaches internal attribute values to operations, identified by
customId.Remove Internal Attributes From Operations In Bulk
Removes internal attribute values from operations, identified by
customId.List Payment Orders
Returns the payment orders of a company, ordered by execution date (most recent first).
Download Payment Order Receipt
Downloads the PDF receipt of a payment order by its Embat
id.List Payments
Returns the payments generated in Embat for a company.
Create Payment
Creates a payment against one or more operations, recording that those operations (invoices/bills) have been settled in…
Update Payments In Bulk
Updates the synchronization status, error message, registration status or additional info of several payments, identifie…
Delete Payments In Bulk
Deletes several payments in a single call, identified by
customId.Retrieve Payment
Returns a single payment by
customId. Payments missing required accounting, operation or contact information are not r…Update Payment
Updates the synchronization status, error message, registration status or additional info of a payment identified by `cu…
Delete Payment
Deletes a payment by
customId.Create Payments In Bulk
Creates several payments in a single call, following the same rules as the single payment creation endpoint.
List Products
Returns the active products (bank accounts, credit lines, cards or wallets) of a company, whether aggregated from a bank…
Update Products In Bulk
Updates the accounting code and/or additional info of several products, identified by
id.Retrieve Product
Returns a single product by its Embat
id.Update Product
Updates the accounting code and/or additional info of a product identified by
id.List Transactions
Returns the bank transactions of a company.
Update Transactions In Bulk
Updates the synchronization status, additional info or custom attribute values of several transactions in a single call,…
Retrieve Transaction
Returns a single transaction by its Embat
id.Update Transaction
Updates the synchronization status, additional info or custom attribute values of a transaction identified by
id.Create Manual Transactions In Bulk
Creates transactions for a company’s product in a single call, grouped by day.