Accounts guide

Introduction

The Accounts API allows you to list, create, retrieve, update, delete, and unarchive accounts.

Accounts API and subscriptions

Since functionality varies between eDocSync and eDocExchange subscriptions, it's important to understand how adding accounts may impact your subscription's costs and limits.

eDocSync

With eDocSync, you can create and manage accounts for your users directly via the API.

Things to consider before adding accounts:

Cost: Adding accounts may result in additional charges, depending on your current subscription and total number of accounts.
Transaction limits: Adding accounts may affect your transaction limits, depending on your current subscription and total number of accounts. The group of accounts has a shared transaction limits. If you exceed the limit, extra charges will be applied per transaction.
Modifications: The subscription transaction limit cannot be changed through the API. To request a change, please submit a support ticket to request a change in your subscription.

eDocExchange

With eDocExchange, you cannot create, delete/archive or unarchive accounts via the API. Instead, this must be done through the web application:

Go to the Developers tab.
Click the Edit group icon next to your group name.
From there, you can add or delete accounts.

Notes: To add or remove accounts, you must have Admin or Owner permissions of the account with the subscription and the account you want to add. Before adding an account to the group, make sure it has been created with the Basic plan.

Things to consider before adding accounts:

Cost: Adding an account results in a one-time additional cost.
Transaction limits: The group of accounts has a shared transaction limits. If you exceed the limit, extra charges will be applied per transaction.
Modifications: The transaction limit cannot be changed through the API. If the web application doesn't offer the option to upgrade your tier in the subscription section, please submit a support ticket to request a change in your subscription.

Example request:

curl --request POST \
  --url 'https://app-staging.b2brouter.net/accounts' \
  --header 'X-B2B-API-KEY: {API_KEY}' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "account": {
      "country": "de",
      "rounding_method": "half_up",
      "tin_scheme": 9930,
      "tin_value": "DE123456789",
      "name": "Muster GmbH",
      "address": "Musterstraße 45",
      "city": "Berlin",
      "postalcode": "10115",
      "province": "Berlin",
      "email": "[email protected]"
    }
  }'