> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Embat

> How to set up the Embat connector, plus the actions that are available.

![Embat](https://stackone-logos.com/api/embat/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/embat/changelog.md)

[59 actions](#actions) · 1 auth method

Accounting

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Service User · Connector Profile](https://docs.stackone.com/connectors/embat/guides/connector-profile/service-user.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Service User · Link Account](https://docs.stackone.com/connectors/embat/guides/link-account/service-user.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

59 actions

ActionDescription

List Accounting Accounts`embat_list_accounting_accounts`

Returns the accounting accounts (chart of accounts) of a company, including deactivated ones.

List Attributes`embat_list_attributes`

Returns all attributes configured for a company, including their `values` when the attribute is of type `list`.

Create Attribute`embat_create_attribute`

Creates an attribute. If `customId` is omitted, Embat auto-generates one.

Update Attributes In Bulk`embat_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`embat_delete_attributes_in_bulk`

Deletes several attributes in a single call, following the same rules as the single attribute deletion endpoint.

Retrieve Attribute`embat_retrieve_attribute`

Returns a single attribute by `customId`.

Update Attribute`embat_update_attribute`

Updates an attribute identified by `customId`.

Delete Attribute`embat_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`embat_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`embat_add_values_to_an_attribute`

Adds values to an existing attribute, identified by `customId`, without affecting its other values.

Remove Values From An Attribute`embat_remove_values_from_an_attribute`

Removes one or more values from an attribute, identified by `customId`.

List Balances`embat_list_balances`

Returns the end-of-day balances of a company's bank products (accounts), one entry per product per day.

Retrieve Balance`embat_retrieve_balance`

Returns a single balance by its Embat `id`.

List Banks`embat_list_banks`

Returns the company's bank relationships.

Retrieve Bank`embat_retrieve_bank`

Returns a single bank relationship by its Embat `id`.

List Categories`embat_list_categories`

Returns every category configured for the company, both top-level and child categories.

Retrieve Category`embat_retrieve_category`

Returns a single category by its Embat `id`.

List User Companies`embat_list_user_companies`

Returns the companies your credentials have access to.

Retrieve Company`embat_retrieve_company`

Returns the detail of a company, including legal name, administrative contact, tags and configuration.

List Company Users`embat_list_company_users`

Returns the users with access to the company identified by `companyId`.

List Contacts`embat_list_contacts`

Returns the contacts (clients/suppliers) of a company.

Create Contact`embat_create_contact`

Creates a contact (client/supplier). If `customId` is omitted, Embat auto-generates one.

Update Contacts In Bulk`embat_update_contacts_in_bulk`

Updates several contacts in a single call, identified by `customId`.

Delete Contacts In Bulk`embat_delete_contacts_in_bulk`

Deletes several contacts in a single call, identified by `customId`.

Retrieve Contact`embat_retrieve_contact`

Returns a single contact by `customId`.

Update Contact`embat_update_contact`

Updates a contact identified by `customId`.

Delete Contact`embat_delete_contact`

Deletes a contact by `customId`. If `customId` does not match any contact, the call returns `404`.

Create Contacts In Bulk`embat_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`embat_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`embat_retrieve_foreign_exchange_rate`

Returns a single foreign exchange rate record by `id`, always expressed against EUR — the `baseCurrency` conversion avai...

List Operations`embat_list_operations`

Returns the operations of a company. By default only the operations created through this API are returned (\`generatedFro...

Create Operation`embat_create_operation`

Creates an operation (invoice/bill) with an optional `customId`; if omitted, Embat auto-generates one.

Update Operations In Bulk`embat_update_operations_in_bulk`

Updates several operations in a single call, identified by `customId`.

Delete Operations In Bulk`embat_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`embat_retrieve_operation`

Returns a single operation by `customId`.

Update Operation`embat_update_operation`

Updates an operation identified by `customId`.

Delete Operation`embat_delete_operation`

Cancels an operation by `customId`: its `status` is set to `cancel` and its pending amounts to 0.

Create Operations In Bulk`embat_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`embat_add_internal_attributes_to_operations_in_bulk`

Attaches internal attribute values to operations, identified by `customId`.

Remove Internal Attributes From Operations In Bulk`embat_remove_internal_attributes_from_operations_in_bulk`

Removes internal attribute values from operations, identified by `customId`.

List Payment Orders`embat_list_payment_orders`

Returns the payment orders of a company, ordered by execution date (most recent first).

Download Payment Order Receipt`embat_download_payment_order_receipt`

Downloads the PDF receipt of a payment order by its Embat `id`.

List Payments`embat_list_payments`

Returns the payments generated in Embat for a company.

Create Payment`embat_create_payment`

Creates a payment against one or more operations, recording that those operations (invoices/bills) have been settled in...

Update Payments In Bulk`embat_update_payments_in_bulk`

Updates the synchronization status, error message, registration status or additional info of several payments, identifie...

Delete Payments In Bulk`embat_delete_payments_in_bulk`

Deletes several payments in a single call, identified by `customId`.

Retrieve Payment`embat_retrieve_payment`

Returns a single payment by `customId`. Payments missing required accounting, operation or contact information are not r...

Update Payment`embat_update_payment`

Updates the synchronization status, error message, registration status or additional info of a payment identified by \`cu...

Delete Payment`embat_delete_payment`

Deletes a payment by `customId`.

Create Payments In Bulk`embat_create_payments_in_bulk`

Creates several payments in a single call, following the same rules as the single payment creation endpoint.

List Products`embat_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`embat_update_products_in_bulk`

Updates the accounting code and/or additional info of several products, identified by `id`.

Retrieve Product`embat_retrieve_product`

Returns a single product by its Embat `id`.

Update Product`embat_update_product`

Updates the accounting code and/or additional info of a product identified by `id`.

List Transactions`embat_list_transactions`

Returns the bank transactions of a company.

Update Transactions In Bulk`embat_update_transactions_in_bulk`

Updates the synchronization status, additional info or custom attribute values of several transactions in a single call,...

Retrieve Transaction`embat_retrieve_transaction`

Returns a single transaction by its Embat `id`.

Update Transaction`embat_update_transaction`

Updates the synchronization status, additional info or custom attribute values of a transaction identified by `id`.

Create Manual Transactions In Bulk`embat_create_manual_transactions_in_bulk`

Creates transactions for a company's product in a single call, grouped by day.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.