Use this reference when you build an integration that reads or changes your accounting structure, business units, G/L accounts, bank accounts, departments, accounting projects, and exchange rates, without opening the Console.
What You Can Read
| Record | Console equivalent | What the API returns |
|---|---|---|
| Business units | Finance & Billing › Setup › Business Units | Every business unit in your Rhythm account |
| G/L accounts | Finance & Billing › Setup › G/L Accounts | Every G/L account in your Rhythm account |
| Bank accounts | Finance & Billing › Setup › Bank Accounts | Every bank account in your Rhythm account |
| Departments | Finance & Billing › Setup › Departments | Every department in your Rhythm account |
| Accounting projects | Finance & Billing › Setup › Accounting Projects | Every accounting project in your Rhythm account |
| Exchange rates | The exchange rate table | Every exchange rate record in your Rhythm account |
You can list each record type or read one record at a time. The caller must be signed in to your Rhythm account before the API can read any of them.
Warning
You cannot filter these reads to one business unit. Every list operation returns the full set of that record type in your Rhythm account, so the API cannot show only one business unit's accounts the way the Console's working business unit control can.
Running Several Changes in One Request
Each of the six record types above also lets you run several create, read, update, and delete operations in one request. Use this when your integration needs to set up or adjust many accounts, departments, or projects at once instead of calling the API once per record.
Tip
Because one batch can freely mix creates, reads, updates, and deletes, have your integration check the result for each item in the batch. Do not assume the whole batch succeeded or failed together.
What You Cannot Do from the API
- A Portal member's own account is limited far more than an integration signed in as staff. A Portal member can read only one business unit's name and currency settings. Nothing else about the accounting structure is available to a Portal session.
- A business unit created through the API gets no fiscal years automatically. When you create a business unit in the Console, Rhythm creates the business unit's first two fiscal years for you. The API's create operation does not, so set up fiscal years separately when you create a business unit through the API.
- Nothing narrows a read or a batch to one business unit. If your integration should only ever touch one business unit's accounts, your integration must filter for that itself because the API always returns or accepts your account's full set.