The Elorus connector lets your AI agent act in each user's Elorus account. Each user connects their own Elorus API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 30 · 22 · 830 read22 write8 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Elorus connection
In AgentKit > Connections, create an Elorus connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'elorus'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Elorus:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'elorus_bills_list',toolInput: { organization_id: '1234567890123456' },})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "elorus"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Elorus:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={"organization_id":"1234567890123456"},tool_name="elorus_bills_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Elorus credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolelorus_bill_getGet one Elorus bill by ID.Read-onlyGet Bill
Get one Elorus bill by ID. Returns all of the bill's fields. Use elorus_bills_list to find the ID.
Inputs
idstringrequired- ID of the bill (supplier invoice). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_bills_listList Elorus bills with search, filters, ordering and paging.Read-onlyList Bills
List Elorus bills with search, filters, ordering and paging. Returns count, next, previous and results[] of bills. Use elorus_bill_get for one bill.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
documenttypestring- Optionally filter by document type ID. Example: 4400000040000123.
draftstring- Optionally filter by draft status. The available choices are: 1, 0.
fpaidstring- Optionally filter by whether the invoice is paid or not. The available choices are: yes, no. Example: 0.
is_voidstring- Optionally filter by void status. The available choices are: 1, 0.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, branch__branch_name, supplier__display_name, total, initial, net, draft, paid, payable, due_date, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
overduestring- Optionally filter by whether the invoice is overdue or not. The available choices are: yes, no. Example: 1.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
pending_approvalstring- Optionally filter by pending status. The available choices are: 1, 0.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
searchstring- A search term. Example: Acme.
self_billedstring- Optionally filter by whether the document is self-billed or not. Can be either 1 or 0. The available choices are: 1, 0.
statusstring- Optionally filter by the document's status. The available choices are: draft, pending, issued, partial, unpaid, overdue, paid, void.
supplierstring- Optionally filter by supplier ID. Example: 3300000040000100.
elorus_cash_payment_getGet one Elorus cash payment by ID.Read-onlyGet Cash Payment
Get one Elorus cash payment by ID. Returns all of the cash payment's fields. Use elorus_cash_payments_list to find the ID.
Inputs
idstringrequired- ID of the cash payment (money paid out). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_cash_payments_listList Elorus cash payments with search, filters, ordering and paging.Read-onlyList Cash Payments
List Elorus cash payments with search, filters, ordering and paging. Returns count, next, previous and results[] of cash payments. Use elorus_cash_payment_get for one cash payment.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
contactstring- Optionally filter by contact ID. Example: 3300000040000100.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
creditnotestring- Optionally filter by credit note ID. Example: 1.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, amount, branch__branch_name, contact__display_name, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
purchasestring- Optionally filter by bill ID. Example: 1.
searchstring- A search term. Example: Acme.
transaction_typestring- Optionally filter by transaction type. Either dp, ip or cnp
elorus_cash_receipt_getGet one Elorus cash receipt by ID.Read-onlyGet Cash Receipt
Get one Elorus cash receipt by ID. Returns all of the cash receipt's fields. Use elorus_cash_receipts_list to find the ID.
Inputs
idstringrequired- ID of the cash receipt (money received). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_cash_receipts_listList Elorus cash receipts with search, filters, ordering and paging.Read-onlyList Cash Receipts
List Elorus cash receipts with search, filters, ordering and paging. Returns count, next, previous and results[] of cash receipts. Use elorus_cash_receipt_get for one cash receipt.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
contactstring- Optionally filter by contact ID. Example: 3300000040000100.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
invoicestring- Optionally filter by invoice ID. Example: 8800000040088865.
is_voidstring- Optionally filter by void status. The available choices are: 1, 0.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, amount, branch__branch_name, contact__display_name, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
pending_approvalstring- Optionally filter by pending status. The available choices are: 1, 0.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
purchasecreditnotestring- Optionally filter by supplier credit ID. Example: 1.
searchstring- A search term. Example: Acme.
transaction_typestring- Optionally filter by transaction type. Either dp, ip or cnp
elorus_contact_getGet one Elorus contact by ID.Read-onlyGet Contact
Get one Elorus contact by ID. Returns all of the contact's fields. Use elorus_contacts_list to find the ID.
Inputs
idstringrequired- ID of the contact (client or supplier). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_contacts_listList Elorus contacts with search, filters, ordering and paging.Read-onlyList Contacts
List Elorus contacts with search, filters, ordering and paging. Returns count, next, previous and results[] of contacts. Use elorus_contact_get for one contact.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
companystring- Optionally filter by company. Example: Acme Inc..
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
ctypestring- Optionally filter by contact type. The available choices are: client, supplier.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
letterstring- Optionally filter by starting letter. Refers to the contact's "display_name." Example: A.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are display_name, profession, vat_number, modified, created. Prepend a - to denote reverse ordering (e.g -display_name). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
professionstring- Optionally filter by profession. Example: Consultant.
searchstring- A search term. Example: Acme.
elorus_credit_note_getGet one Elorus credit note by ID.Read-onlyGet Credit Note
Get one Elorus credit note by ID. Returns all of the credit note's fields. Use elorus_credit_notes_list to find the ID.
Inputs
idstringrequired- ID of the credit note. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_credit_notes_listList Elorus credit notes with search, filters, ordering and paging.Read-onlyList Credit Notes
List Elorus credit notes with search, filters, ordering and paging. Returns count, next, previous and results[] of credit notes. Use elorus_credit_note_get for one credit note.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
clientstring- Optionally filter by client ID. Example: 3300000040000100.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
documenttypestring- Optionally filter by document type ID. Example: 4400000040000123.
draftstring- Optionally filter by draft status. The available choices are: 1, 0.
fpaidstring- Optionally filter by whether the invoice is paid or not. The available choices are: 1, 0.
is_voidstring- Optionally filter by void status. The available choices are: 1, 0.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, documenttype__title, client__display_name, total, initial, net, draft, paid, payable, branch__branch_name, number, sequence_flat, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
pending_approvalstring- Optionally filter by pending status. The available choices are: 1, 0.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
searchstring- A search term. Example: Acme.
sequencestring- Optionally filter by the numbering sequence. Example: A.
statusstring- Optionally filter by the document's status. The available choices are: draft, pending, issued, partial, unpaid, paid, void.
elorus_delivery_notes_listList Elorus delivery notes with search, ordering and paging.Read-onlyList Delivery Notes
List Elorus delivery notes with search, ordering and paging. Returns count, next, previous and results[] of delivery notes. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
contactstring- Optionally filter by contact ID. Example: 3300000040000100.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
documenttypestring- Optionally filter by document type ID. Example: 4400000040000123.
draftstring- Optionally filter by draft status. The available choices are: 1, 0.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, documenttype__title, branch__branch_name, contact__display_name, total, initial, net, draft, number, sequence_flat, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
searchstring- A search term. Example: Acme.
sequencestring- Optionally filter by the numbering sequence. Example: A.
statusstring- Optionally filter by the document's status. Available choices are draft and issued The available choices are: draft, issued. Example: unpaid.
elorus_document_types_listList Elorus document types with search, ordering and paging.Read-onlyList Document Types
List Elorus document types with search, ordering and paging. Returns count, next, previous and results[] of document types. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
always_self_billedstring- A base custom filter for boolean fields. The available choices are: 1, 0.
applicationstring- Optional filter. The available choices are: 1, 2, 3, 4, 5. Example: sales.
is_delivery_notestring- A base custom filter for boolean fields. The available choices are: 1, 0.
is_reverse_delivery_notestring- A base custom filter for boolean fields. The available choices are: 1, 0.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are title, active, application, created, modified. Prepend a - to denote reverse ordering (e.g -title). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
searchstring- A search term. Example: Acme.
elorus_email_templates_listList Elorus email templates with search, ordering and paging.Read-onlyList Email Templates
List Elorus email templates with search, ordering and paging. Returns count, next, previous and results[] of email templates. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
email_typestring- Optional filter. The available choices are: invoice, estimate, purchase, cashreceipt, client_statement.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are subject, email_type, message, default_for_language, default, modified, created. Prepend a - to denote reverse ordering (e.g -subject). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
searchstring- A search term. Example: Acme.
elorus_estimate_getGet one Elorus estimate by ID.Read-onlyGet Estimate
Get one Elorus estimate by ID. Returns all of the estimate's fields. Use elorus_estimates_list to find the ID.
Inputs
idstringrequired- ID of the estimate. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_estimates_listList Elorus estimates with search, filters, ordering and paging.Read-onlyList Estimates
List Elorus estimates with search, filters, ordering and paging. Returns count, next, previous and results[] of estimates. Use elorus_estimate_get for one estimate.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
accept_statusstring- Optionally filter by accept status. The available choices are: accepted, rejected, empty.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
clientstring- Optionally filter by client ID. Example: 3300000040000100.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
documenttypestring- Optionally filter by document type ID. Example: 4400000040000123.
draftstring- Optionally filter by draft status. The available choices are: 1, 0.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, documenttype__title, branch__branch_name, client__display_name, total, initial, net, draft, number, sequence_flat, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
searchstring- A search term. Example: Acme.
sequencestring- Optionally filter by the numbering sequence. Example: A.
statusstring- Optionally filter by the document's status. The available choices are: draft, issued, accepted, rejected, invoiced. Example: unpaid.
elorus_expense_categories_listList Elorus expense categorys with search, ordering and paging.Read-onlyList Expense Categories
List Elorus expense categorys with search, ordering and paging. Returns count, next, previous and results[] of expense categorys. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are title, created, modified. Prepend a - to denote reverse ordering (e.g -title). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
searchstring- A search term. Example: Acme.
elorus_expense_getGet one Elorus expense by ID.Read-onlyGet Expense
Get one Elorus expense by ID. Returns all of the expense's fields. Use elorus_expenses_list to find the ID.
Inputs
idstringrequired- ID of the expense. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_expenses_listList Elorus expenses with search, filters, ordering and paging.Read-onlyList Expenses
List Elorus expenses with search, filters, ordering and paging. Returns count, next, previous and results[] of expenses. Use elorus_expense_get for one expense.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
branch_idstring- Optionally filter by branch ID. Example: 5500000050000678.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, branch__branch_name, supplier__display_name, net, total, created, modified, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
searchstring- A search term. Example: Acme.
supplierstring- Optionally filter by supplier ID. Example: 3300000040000100.
elorus_invoice_getGet one Elorus invoice by ID.Read-onlyGet Invoice
Get one Elorus invoice by ID. Returns all of the invoice's fields. Use elorus_invoices_list to find the ID.
Inputs
idstringrequired- ID of the invoice. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_invoices_listList Elorus invoices with search, filters, ordering and paging.Read-onlyList Invoices
List Elorus invoices with search, filters, ordering and paging. Returns count, next, previous and results[] of invoices. Use elorus_invoice_get for one invoice.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
clientstring- Optionally filter by client ID. Example: 3300000040000100.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
documenttypestring- Optionally filter by document type ID. Example: 4400000040000123.
draftstring- Optionally filter by draft status. The available choices are: 1, 0.
fpaidstring- Optionally filter by whether the invoice is paid or not. The available choices are: 1, 0.
is_voidstring- Optionally filter by void status. The available choices are: 1, 0.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are date, documenttype__title, client__display_name, total, initial, net, draft, paid, payable, number, sequence_flat, due_date, branch__branch_name, modified, created. Prepend a - to denote reverse ordering (e.g -date). Example: -created.
overduestring- Optionally filter by whether the invoice is overdue or not. The available choices are: 1, 0.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
pending_approvalstring- Optionally filter by pending status. The available choices are: 1, 0.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
searchstring- A search term. Example: Acme.
sequencestring- Optionally filter by the numbering sequence. Example: A.
statusstring- Optionally filter by the document's status. The available choices are: draft, pending, issued, partial, unpaid, overdue, paid, void.
elorus_product_getGet one Elorus product or service by ID.Read-onlyGet Product Or Service
Get one Elorus product or service by ID. Returns all of the product or service's fields. Use elorus_products_list to find the ID.
Inputs
idstringrequired- ID of the product or service. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_products_listList Elorus product or services with search, filters, ordering and paging.Read-onlyList Products
List Elorus product or services with search, filters, ordering and paging. Returns count, next, previous and results[] of product or services. Use elorus_product_get for one product or service.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are title, sales, sale_value, purchases, purchase_value, manage, code, modified, created. Prepend a - to denote reverse ordering (e.g -title). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
purchasesstring- Optionally filter by purchase status. The available choices are: 1, 0.
salesstring- Optionally filter by sales status. The available choices are: 1, 0.
searchstring- A search term. Example: Acme.
elorus_project_getGet one Elorus project by ID.Read-onlyGet Project
Get one Elorus project by ID. Returns all of the project's fields. Use elorus_projects_list to find the ID.
Inputs
idstringrequired- ID of the project. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_projects_listList Elorus projects with search, filters, ordering and paging.Read-onlyList Projects
List Elorus projects with search, filters, ordering and paging. Returns count, next, previous and results[] of projects. Use elorus_project_get for one project.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
billing_methodstring- Optional filter. The available choices are: fixed_cost, project_rate, task_rate, assignee_rate, non_billable. Example: hourly.
clientstring- Optionally filter by client ID. Example: 3300000040000100.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are name, client__display_name, created, modified. Prepend a - to denote reverse ordering (e.g -name). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
searchstring- A search term. Example: Acme.
elorus_recurring_invoice_getGet one Elorus recurring invoice by ID.Read-onlyGet Recurring Invoice
Get one Elorus recurring invoice by ID. Returns all of the recurring invoice's fields. Use elorus_recurring_invoices_list to find the ID.
Inputs
idstringrequired- ID of the recurring invoice. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_recurring_invoices_listList Elorus recurring invoices with search, filters, ordering and paging.Read-onlyList Recurring Invoices
List Elorus recurring invoices with search, filters, ordering and paging. Returns count, next, previous and results[] of recurring invoices. Use elorus_recurring_invoice_get for one recurring invoice.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
clientstring- Optionally filter by client ID. Example: 3300000040000100.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
currency_codestring- Optionally filter by currency code. Example: EUR.
custom_idstring- Optionally filter by custom ID. Example: ABC-123-a1.
documenttypestring- Optionally filter by document type ID. Example: 4400000040000123.
draftstring- Optionally filter by draft status. The available choices are: 1, 0.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are start_datetime, end_datetime, sequence_flat, documenttype__title, branch__branch_name, client__display_name, total, payable, initial, net, draft, modified, created. Prepend a - to denote reverse ordering (e.g -start_datetime). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
recurring_statusstring- Optionally filter by recurring status. The available choices are: active, paused, expired.
searchstring- A search term. Example: Acme.
sequencestring- Optionally filter by the numbering sequence. Example: A.
elorus_tasks_listList Elorus tasks with search, ordering and paging.Read-onlyList Tasks
List Elorus tasks with search, ordering and paging. Returns count, next, previous and results[] of tasks. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are name, hourly_rate, active, created, modified. Prepend a - to denote reverse ordering (e.g -name). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
projectstring- Optional filter. Example: 7700000040000100.
searchstring- A search term. Example: Acme.
elorus_taxes_listList Elorus taxs with search, ordering and paging.Read-onlyList Taxes
List Elorus taxs with search, ordering and paging. Returns count, next, previous and results[] of taxs. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
created_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
created_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
modified_afterstring- Optionally filter results from a date onwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-01.
modified_beforestring- Optionally filter results from a date backwards. Date must be in the form of YYYY-mm-dd or ISO-formatted. Example: 2026-11-30.
operandstring- Optionally filter by operand. The available choices are: plus, minus. Example: add.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are title, operand, percentage, active, tax_type, modified, created. Prepend a - to denote reverse ordering (e.g -title). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
searchstring- A search term. Example: Acme.
tax_typestring- Optionally filter by tax type. The available choices are: simple, vat, withholding.
elorus_time_entries_listList Elorus time entrys with search, ordering and paging.Read-onlyList Time Entries
List Elorus time entrys with search, ordering and paging. Returns count, next, previous and results[] of time entrys. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
assigneestring- Optional filter. Example: 1100000040000100.
billing_statusstring- Optional filter. The available choices are: non-billable, billed, unbilled.
clientstring- Optionally filter by client ID. Example: 3300000040000100.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are start_datetime, project__name, task__name. Prepend a - to denote reverse ordering (e.g -start_datetime). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
periodstring- Optionally filter results from a date period. Date period must be one of the following constants: today,current_week, current_month, current_year, last_week, last_month, last_year or in the form of this template last_ _
period_fromstring- Optionally filter results from a date onwards. Must be used with the period_to parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-01.
period_tostring- Optionally filter results from a date backwards. Must be used with the period_from parameter, otherwise it won't have any effect. Date must be in the form of YYYY-mm-dd. Example: 2026-11-30.
projectstring- Optional filter. Example: 7700000040000100.
searchstring- A search term. Example: Acme.
taskstring- Optional filter. Example: 7800000040000100.
user_teamstring- Filter time entries by team ID. Example: 1200000040000100.
elorus_users_listList Elorus users with search, ordering and paging.Read-onlyList Users
List Elorus users with search, ordering and paging. Returns count, next, previous and results[] of users. Use their IDs when creating or updating other records.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activestring- Whether to show only active or inactive (archived) records. The available choices are: 1, 0.
orderingstring- Which field to use when ordering the results. A comma-separated list, if more than one is provided. The available fields are pk. Prepend a - to denote reverse ordering (e.g -pk). Example: -created.
pageinteger- A page number within the paginated result set. Example: 1.
page_sizeinteger- Number of results to return per page. Default is 100. The maximum allowed value is 250.
searchstring- A search term. Example: Acme.
elorus_bill_createCreate an Elorus bill (supplier invoice).WriteCreate Bill
Create an Elorus bill (supplier invoice). Returns the new bill with its id. Use elorus_bills_list to check for an existing record first.
Inputs
itemsarrayrequired- Line items of a bill. Example: [{"product": "9900000040000600", "description": "Super-cool expensive socks!"}].
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
supplierstringrequired- ID of the associated supplier. Example: 3300000040000100.
billing_addressobject- The client billing address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
branchstring- ID of the associated branch. Example: 5500000050000678.
calculator_modestring- Automatically calculate / correct document values based on the specified calculation mode. Values: initial (Tax-exclusive), total (Tax-inclusive, after discounts), total_pre_discount (Tax-inclusive, before discounts).one of
initialtotaltotal_pre_discount currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
datestring- The issue date. Date is in the form of YYYY-mm-dd. Example: 2018-10-25.
delivery_notesarray- A list of deliverynote IDs linked to this document. Example: ["text"].
dispatch_datestring- Date is in the form of YYYY-mm-dd. Example: 2026-11-16.
dispatch_timestring- Dispatch time Example: 09:30.
documenttypestring- Optionally, associate the record with a document type to denote the type of the received document. This field is required in case of a self-billed document. Example: 4400000040000123.
draftboolean- If true the document is considered to be a work in progress. Example: 0.
due_daysinteger- Days after the issue date, that the invoice will be considered overdue. This affects the document's due date . Use null to not set a due date. Example: 10.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
loading_addressobject- The document loading address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
move_purposeinteger- Values: 9 (Purchase).one of
9 packagesarray- Packages included in the transport. Example: [{"packaging_type": 1, "quantity": 2}].
public_notesstring- Applies only to self-billed invoices. These notes will appear on the PDF. Example: Notes visible on the bill..
referencestring- A reference code. Usually, the document number as specified by the supplier. Example: ABC111.
related_documentsarray- A list of purchase IDs linked to this document. Example: ["text"].
related_entitiesarray- related_entities Example: [{"contact": "3300000040000100", "contact_display_name": "Acme Inc.", "type": 1}].
self_billedboolean- Denotes whether this is a self-billed invoice. This value is auto-generated and depends on the bill's document type. Example: 0.
sequence_flatstring- Sequence Example: A.
shipping_addressobject- The client shipping address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
supplier_contact_personstring- Applies only to self-billed invoices. The supplier's contact person, as it will appear on the PDF. Example: Jane Roe.
supplier_display_namestring- Applies only to self-billed invoices. The supplier name as it will appear on the PDF. Example: Supplies Ltd.
supplier_emailstring- Applies only to self-billed invoices. The supplier email address, as it will appear on the PDF. Example: billing@supplies.example.
supplier_phone_numberstring- Applies only to self-billed invoices. The supplier phone number, as it will appear on the PDF. Example: 662-222-3333.
supplier_professionstring- Applies only to self-billed invoices. The supplier profession, as it will appear on the PDF. Example: Wholesale.
supplier_vat_numberstring- Supplier tax ID Example: 987654321.
taxesarray- A list of taxes to be applied (optional). If the document contains taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other taxes. You may also include additional taxes, which will be calculated based on the total net amount of the document. Example: [{"tax": "6600230050000705"}].
templatestring- Applies only to self-billed invoices. The template to use when rendering to PDF. Example: 5500000050000999.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
vehicle_numberstring- Vehicle number Example: ABC-1234.
withholding_taxesarray- A list of withholding taxes to be applied. If the document contains withholding taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other withholding taxes. Example: [{"tax": "1400230050000705"}].
elorus_bill_updateUpdate fields of an Elorus bill (PATCH).WriteUpdate Bill
Update fields of an Elorus bill (PATCH). Only the fields you send change. Returns the updated bill. Use elorus_bill_get to read current values; use elorus_bill_void to void it.
- Idempotent
Inputs
idstringrequired- ID of the bill (supplier invoice). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
draftboolean- If true the document is considered to be a work in progress. Example: 0.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. This field is read-only while the record is in pending approval status. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
elorus_cash_payment_createCreate an Elorus cash payment (money paid out).WriteCreate Cash Payment
Create an Elorus cash payment (money paid out). Returns the new cash payment with its id. Use elorus_cash_payments_list to check for an existing record first.
Inputs
amountstringrequired- Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 100.00.
contactstringrequired- ID of the associated contact. Example: 3300000040000100.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
transaction_typestringrequired- Values: dp (Other payments), ip (Supplier payment), cnp (Client refund).one of
dpipcnp branchstring- ID of the associated branch. Example: 5500000050000678.
creditnote_paymentsarray- A list of the credit notes paid via this transaction. Applies to "Client refund" transactions. Example: [{"creditnote": "1050000300010040", "amount": "20"}].
currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
datestring- Date is in the form of YYYY-mm-dd. Example: 2018-10-25.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
purchase_paymentsarray- A list of the bills paid via this transaction. Applies to "Supplier payment" transactions. Example: [{"purchase": "8800000040088865", "amount": "80"}].
titlestring- Short description / reason. Example: A supplier invoice payment.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
elorus_cash_receipt_createCreate an Elorus cash receipt (money received).WriteCreate Cash Receipt
Create an Elorus cash receipt (money received). Returns the new cash receipt with its id. Use elorus_cash_receipts_list to check for an existing record first.
Inputs
amountstringrequired- Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 100.00.
contactstringrequired- ID of the associated contact. Example: 3300000040000100.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
transaction_typestringrequired- Values: dp (Other payments), ip (Client payment), cnp (Supplier refund), icm (Income).one of
dpipcnpicm branchstring- ID of the associated branch. Example: 5500000050000678.
calculator_modestring- Applies only to "Income" transactions and dictates how amounts will be calculated if there exist associated taxes. One of the following, or empty Values: initial (Tax-exclusive), total (Tax-inclusive).one of
initialtotal currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
datestring- Date is in the form of YYYY-mm-dd. Example: 2018-10-25.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
income_typestring- Applies only to "Income" transactions. One of the following, or empty Values: contract (Contract income), rental (Rental income), other_income (Other income).one of
contractrentalother_income invoice_paymentsarray- A list of the invoices paid via this transaction. Applies to "Client payment" transactions. Example: [{"invoice": "8800000040088865", "amount": "100.00"}].
purchasecreditnote_paymentsarray- A list of the purchase credit notes paid via this transaction. Applies to "Supplier refund" transactions. Example: [{"purchasecreditnote": "4400000040000555", "amount": "50.00"}].
taxesarray- A list of the applied tax IDs. Applies only to "Income" transactions. Example: ["6600230050000705"].
titlestring- Short description / reason. Example: An invoice payment.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
elorus_contact_createCreate an Elorus contact (client or supplier).WriteCreate Contact
Create an Elorus contact (client or supplier). Returns the new contact with its id. Use elorus_contacts_list to check for an existing record first.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activeboolean- You can archive contacts to shorten your lists without losing any data. Archived contacts cannot be invoiced, cannot login to the client portal and cannot be assigned to new projects. Example: 1.
addressesarray- A list of postal addresses. Example: [{"address": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}].
companystring- The company that the contact represents. Example: Acme Inc..
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
default_currency_codestring- The currency used by default when invoicing this contact. One of the following, or empty Values: AED (AED - UAE Dirham), AFN (AFN - Afghani), ALL (ALL - Lek), AMD (AMD - Armenian Dram), ANG (ANG - Netherlands Antillian Guilder), AOA (AOA - Kwanza), ARS (ARS - Argentine Peso), AUD (AUD - Australian Dollar), AWG (AWG - Aruban Florin), AZN (AZN - Azerbaijanian Manat), BAM (BAM - C... Example: USD.
default_languagestring- Values: en (English), en-gb (English (United Kingdom)), el (Greek), fr (French), de (German), it (Italian), es (Spanish), bg (Bulgarian).one of
enen-gbelfrdeitesbg default_taxesarray- A list of tax IDs that should apply by default when invoicing the contact Example: ["0116700303010117"].
default_templatestring- ID of the template that will be used by default when invoicing this contact. Example: 5500000050000999.
emailarray- A list of email addresses. Example: [{"email": "john@doe.com", "primary": true}].
first_namestring- First name of the contact. Example: John.
is_clientboolean- Whether the contact is a client or not. Example: true.
is_supplierboolean- Whether the contact is a supplier or not. Example: true.
last_namestring- Last name of the contact. Example: Doe.
phonesarray- A list of phone numbers. Example: [{"number": "662-222-2222", "primary": true}].
professionstring- Industry / profession. Example: Consultant.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
vat_numberstring- The tax ID of the contact. Example: 123456789.
elorus_contact_updateReplace an Elorus contact's data (PUT): send every field you want to keep, including required ones.WriteUpdate Contact
Replace an Elorus contact's data (PUT): send every field you want to keep, including required ones. Returns the updated contact. Use elorus_contact_get to read the current values first.
- Idempotent
Inputs
idstringrequired- ID of the contact (client or supplier). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activeboolean- You can archive contacts to shorten your lists without losing any data. Archived contacts cannot be invoiced, cannot login to the client portal and cannot be assigned to new projects. Example: 1.
addressesarray- A list of postal addresses. Example: [{"address": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}].
companystring- The company that the contact represents. Example: Acme Inc..
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
default_currency_codestring- The currency used by default when invoicing this contact. One of the following, or empty Values: AED (AED - UAE Dirham), AFN (AFN - Afghani), ALL (ALL - Lek), AMD (AMD - Armenian Dram), ANG (ANG - Netherlands Antillian Guilder), AOA (AOA - Kwanza), ARS (ARS - Argentine Peso), AUD (AUD - Australian Dollar), AWG (AWG - Aruban Florin), AZN (AZN - Azerbaijanian Manat), BAM (BAM - C... Example: USD.
default_languagestring- Values: en (English), en-gb (English (United Kingdom)), el (Greek), fr (French), de (German), it (Italian), es (Spanish), bg (Bulgarian).one of
enen-gbelfrdeitesbg default_taxesarray- A list of tax IDs that should apply by default when invoicing the contact Example: ["0116700303010117"].
default_templatestring- ID of the template that will be used by default when invoicing this contact. Example: 5500000050000999.
emailarray- A list of email addresses. Example: [{"email": "john@doe.com", "primary": true}].
first_namestring- First name of the contact. Example: John.
is_clientboolean- Whether the contact is a client or not. Example: true.
is_supplierboolean- Whether the contact is a supplier or not. Example: true.
last_namestring- Last name of the contact. Example: Doe.
phonesarray- A list of phone numbers. Example: [{"number": "662-222-2222", "primary": true}].
professionstring- Industry / profession. Example: Consultant.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
vat_numberstring- The tax ID of the contact. Example: 123456789.
elorus_credit_note_createCreate an Elorus credit note.WriteCreate Credit Note
Create an Elorus credit note. Returns the new credit note with its id. Use elorus_credit_notes_list to check for an existing record first.
Inputs
clientstringrequired- ID of the associated client. Example: 3300000040000100.
datestringrequired- The issue date. Date is in the form of YYYY-mm-dd. Example: 2018-10-25.
itemsarrayrequired- items Example: [{"product": "9900000040000600", "title": "Pair of socks"}].
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
billing_addressobject- The client billing address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
branchstring- ID of the associated branch. Example: 5500000050000678.
calculator_modestring- Automatically calculate / correct document values based on the specified calculation mode. Values: initial (Tax-exclusive), total (Tax-inclusive, after discounts), total_pre_discount (Tax-inclusive, before discounts).one of
initialtotaltotal_pre_discount client_contact_personstring- The client's contact person, as it will appear on the PDF. Example: John Doe.
client_display_namestring- If not provided, the client name will be retrieved from the specified client contact Example: Acme Inc..
client_emailstring- The client email address, as it will appear on the PDF. Example: john@doe.com.
client_phone_numberstring- The client phone number, as it will appear on the PDF. Example: 662-222-2222.
client_professionstring- The client profession, as it will appear on the PDF. Example: Digital marketing.
client_vat_numberstring- The client tax ID, as it will appear on the PDF. Example: 123451234.
currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
dispatch_datestring- Date is in the form of YYYY-mm-dd. Example: 2026-11-16.
dispatch_timestring- Dispatch time Example: 09:30.
documenttypestring- ID of the associated document type. Example: 4400000040000123.
draftboolean- If true the document is considered to be a work in progress. Example: 0.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
loading_addressobject- The document loading address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
move_purposeinteger- Values: 1 (Sale), 2 (Sales on Behalf of Third Parties), 5 (Return), 10 (Provision of Ships and Aircraft).one of
12510 numberstring- Use empty string or do not send it at all, for automatic numbering. Example: 1001.
packagesarray- Packages included in the transport. Example: [{"packaging_type": 1, "quantity": 2}].
public_notesstring- These notes are displayed on the document's printable form. Example: Notes visible on the credit note.
related_documentsarray- A list of invoice IDs linked to this document. Example: ["4400230020000542"].
related_entitiesarray- Additional parties involved in the transport. This field applies only to documents that include transport information (i.e., when the is_delivery_note property of the corresponding document type is set to true) Example: [{"contact": "3300000040000100", "contact_display_name": "Acme Inc.", "type": 3}].
sequence_flatstring- Sequence Example: A.
shipping_addressobject- The client shipping address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
taxesarray- A list of taxes to be applied (optional). If the document contains taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other taxes. You may also include additional taxes, which will be calculated based on the total net amount of the document. Example: [{"tax": "6600230050000705"}].
templatestring- ID of the associated template. Example: 5500000050000999.
termsstring- These terms are displayed on the document's printable form. Example: Terms and conditions here.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
vehicle_numberstring- Vehicle number Example: ABC-1234.
withholding_taxesarray- A list of withholding taxes to be applied. If the document contains withholding taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other withholding taxes. Example: [{"tax": "1400230050000705"}].
elorus_estimate_createCreate an Elorus estimate.WriteCreate Estimate
Create an Elorus estimate. Returns the new estimate with its id. Use elorus_estimates_list to check for an existing record first.
Inputs
clientstringrequired- ID of the associated client. Example: 3300000040000100.
itemsarrayrequired- Line items of an estimate. Example: [{"product": "9900000040000600", "title": "Pair of socks"}].
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
accept_statusstring- Whether the client has accepted / rejected the estimate. One of the following, or empty Values: accepted (Accepted), rejected (Rejected).one of
acceptedrejected billing_addressobject- The client billing address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
branchstring- ID of the associated branch. Example: 5500000050000678.
calculator_modestring- Automatically calculate / correct document values based on the specified calculation mode. Values: initial (Tax-exclusive), total (Tax-inclusive, after discounts), total_pre_discount (Tax-inclusive, before discounts).one of
initialtotaltotal_pre_discount client_contact_personstring- The client's contact person, as it will appear on the PDF. Example: John Doe.
client_display_namestring- If not provided, the client name will be retrieved from the specified client contact Example: Acme Inc..
client_emailstring- The client email address, as it will appear on the PDF. Example: john@doe.com.
client_phone_numberstring- The client phone number, as it will appear on the PDF. Example: 662-222-2222.
client_professionstring- The client profession, as it will appear on the PDF. Example: Digital marketing.
client_vat_numberstring- The client tax ID, as it will appear on the PDF. Example: 123451234.
currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
datestring- The issue date. Date is in the form of YYYY-mm-dd. Example: 2018-10-25.
documenttypestring- ID of the associated document type. Example: 4400000040000123.
draftboolean- If true the document is considered to be a work in progress. Example: 0.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
numberstring- Use empty string or do not send it at all, for automatic numbering. Example: 1001.
public_notesstring- These notes are displayed on the document's printable form. Example: Notes visible on the estimate.
sequence_flatstring- Sequence Example: A.
shipping_addressobject- The client shipping address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
taxesarray- A list of taxes to be applied (optional). If the document contains taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other taxes. You may also include additional taxes, which will be calculated based on the total net amount of the document. Example: [{"tax": "6600230050000705"}].
templatestring- ID of the associated template. Example: 5500000050000999.
termsstring- These terms are displayed on the document's printable form. Example: Terms and conditions here.
elorus_estimate_emailEmail an Elorus estimate to a recipient, optionally with its PDF attached.WriteEmail Estimate
Email an Elorus estimate to a recipient, optionally with its PDF attached. Returns the sent email details. Use elorus_estimate_get to check the estimate first.
Inputs
attach_pdfbooleanrequired- Whether to include the PDF version of the document as attachment or not. Example: true.
bccarrayrequired- A list of email addresses to blind carbon-copy the email to. Example: ["accounting@example.com"].
ccarrayrequired- A list of email addresses to carbon-copy the email to. Example: ["accounting@doe.com"].
idstringrequired- ID of the estimate. Example: 4400000040000123.
messagestringrequired- The email message. May contain html. Example: Hello,<br/>please find the PDF attached..
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
subjectstringrequired- The email subject.
tostringrequired- The recipient email address. Example: someone@example.com.
attachmentsarray- A list of estimate attachment IDs to attach in the email Example: ["1050000300010040"].
sender_namestring- Sender display name Example: Acme Billing.
store_toboolean- Store the recipient address on the client contact for future use. Example: true.
elorus_estimate_updateUpdate fields of an Elorus estimate (PATCH).WriteUpdate Estimate
Update fields of an Elorus estimate (PATCH). Only the fields you send change. Returns the updated estimate. Use elorus_estimate_get to read current values.
- Idempotent
Inputs
idstringrequired- ID of the estimate. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
accept_statusstring- Whether the client has accepted / rejected the estimate. One of the following, or empty Values: accepted (Accepted), rejected (Rejected).one of
acceptedrejected custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
draftboolean- If true the document is considered to be a work in progress. Example: 0.
templatestring- ID of the associated template. Example: 5500000050000999.
elorus_expense_createCreate an Elorus expense.WriteCreate Expense
Create an Elorus expense. Returns the new expense with its id. Use elorus_expenses_list to check for an existing record first.
Inputs
itemsarrayrequired- Line items of an expense. Example: [{"expense_category": "4416700785030129", "description": "Some text here"}].
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
branchstring- ID of the associated branch. Example: 5500000050000678.
calculator_modestring- Automatically calculate / correct document values based on the specified calculation mode. Values: initial (Tax-exclusive), total (Tax-inclusive).one of
initialtotal currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
datestring- The issue date. Date is in the form of YYYY-mm-dd. Example: 2019-01-28.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
netstring- Total net value, before any taxes are applied. Automatically calculated amount. Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 80.00.
referencestring- A reference code. Usually, the document number as specified by the supplier. Example: ABC111.
supplierstring- ID of the associated supplier. Example: 3300000040000100.
taxesarray- A list of taxes to be applied (optional). If the document contains taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other taxes. You may also include additional taxes, which will be calculated based on the total net amount of the document. Example: [{"tax": "6600230050000705"}].
totalstring- Automatically calculated amount. Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 100.00.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
elorus_expense_updateReplace an Elorus expense's data (PUT): send every field you want to keep, including required ones.WriteUpdate Expense
Replace an Elorus expense's data (PUT): send every field you want to keep, including required ones. Returns the updated expense. Use elorus_expense_get to read the current values first.
- Idempotent
Inputs
idstringrequired- ID of the expense. Example: 4400000040000123.
itemsarrayrequired- Line items of an expense. Example: [{"id": "1050000300010040", "expense_category": "4416700785030129", "description": "Some text here"}].
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
branchstring- ID of the associated branch. Example: 5500000050000678.
calculator_modestring- Automatically calculate / correct document values based on the specified calculation mode. Values: initial (Tax-exclusive), total (Tax-inclusive).one of
initialtotal currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
datestring- The issue date. Date is in the form of YYYY-mm-dd. Example: 2019-01-28.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
netstring- Total net value, before any taxes are applied. Automatically calculated amount. Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 80.00.
referencestring- A reference code. Usually, the document number as specified by the supplier. Example: ABC111.
supplierstring- ID of the associated supplier. Example: 3300000040000100.
taxesarray- A list of taxes to be applied (optional). If the document contains taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other taxes. You may also include additional taxes, which will be calculated based on the total net amount of the document. Example: [{"tax": "6600230050000705"}].
totalstring- Automatically calculated amount. Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 100.00.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
elorus_invoice_createCreate an Elorus invoice.WriteCreate Invoice
Create an Elorus invoice. Returns the new invoice with its id. Use elorus_invoices_list to check for an existing record first.
Inputs
clientstringrequired- ID of the associated client. Example: 3300000040000100.
datestringrequired- The issue date. Date is in the form of YYYY-mm-dd. Example: 2018-10-25.
itemsarrayrequired- items Example: [{"product": "9900000040000600", "title": "Pair of socks"}].
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
billing_addressobject- The client billing address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
branchstring- ID of the associated branch. Example: 5500000050000678.
calculator_modestring- Automatically calculate / correct document values based on the specified calculation mode. Values: initial (Tax-exclusive), total (Tax-inclusive, after discounts), total_pre_discount (Tax-inclusive, before discounts).one of
initialtotaltotal_pre_discount client_contact_personstring- The client's contact person, as it will appear on the PDF. Example: John Doe.
client_display_namestring- If not provided, the client name will be retrieved from the specified client contact Example: Acme Inc..
client_emailstring- The client email address, as it will appear on the PDF. Example: john@doe.com.
client_phone_numberstring- The client phone number, as it will appear on the PDF. Example: 662-222-2222.
client_professionstring- The client profession, as it will appear on the PDF. Example: Digital marketing.
client_vat_numberstring- The client tax ID, as it will appear on the PDF. Example: 123451234.
currency_codestring- If not specified, this is set to the contact's default currency code if it exists. In other case the organization's base currency code is used. Example: EUR.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
delivery_notesarray- A list of deliverynote IDs linked to this document. Example: ["4400230020000544"].
dispatch_datestring- Date is in the form of YYYY-mm-dd. Example: 2026-11-16.
dispatch_timestring- Dispatch time Example: 09:30.
documenttypestring- ID of the associated document type. Example: 4400000040000123.
draftboolean- If true the document is considered to be a work in progress. Example: 0.
due_daysinteger- Days after the issue date, that the invoice will be considered overdue. This affects the document's due date . Use null to not set a due date. Example: 10.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
loading_addressobject- The document loading address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
move_purposeinteger- Values: 1 (Sale), 2 (Sales on Behalf of Third Parties), 10 (Provision of Ships and Aircraft).one of
1210 numberstring- Use empty string or do not send it at all, for automatic numbering. Example: 1001.
packagesarray- Packages included in the transport. Example: [{"packaging_type": 1, "quantity": 2}].
public_notesstring- These notes are displayed on the document's printable form. Example: Notes visible on the invoice.
related_documentsarray- A list of invoice IDs linked to this document. Example: ["4400230020000543"].
related_entitiesarray- Additional parties involved in the transport. This field applies only to documents that include transport information (i.e., when the is_delivery_note property of the corresponding document type is set to true) Example: [{"contact": "3300000040000100", "contact_display_name": "Acme Inc.", "type": 3}].
sequence_flatstring- Sequence Example: A.
shipping_addressobject- The client shipping address. Example: {"address_line": "4 Catherine St.", "city": "Southaven", "zip": "38671", "country": "US"}.
taxesarray- A list of taxes to be applied (optional). If the document contains taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other taxes. You may also include additional taxes, which will be calculated based on the total net amount of the document. Example: [{"tax": "6600230050000705"}].
templatestring- ID of the associated template. Example: 5500000050000999.
termsstring- These terms are displayed on the document's printable form. Example: Terms and conditions here.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
vehicle_numberstring- Vehicle number Example: ABC-1234.
withholding_taxesarray- A list of withholding taxes to be applied. If the document contains withholding taxes that have already been applied at the line level, you may optionally resend them here. This will help specify the order that these taxes will have among the other withholding taxes. Example: [{"tax": "1400230050000705"}].
elorus_invoice_emailEmail an Elorus invoice to a recipient, optionally with its PDF attached.WriteEmail Invoice
Email an Elorus invoice to a recipient, optionally with its PDF attached. Returns the sent email details. Use elorus_invoice_get to check the invoice first.
Inputs
attach_pdfbooleanrequired- Whether to include the PDF version of the document as attachment or not. Example: true.
bccarrayrequired- A list of email addresses to blind carbon-copy the email to. Example: ["accounting@example.com"].
ccarrayrequired- A list of email addresses to carbon-copy the email to. Example: ["accounting@doe.com"].
idstringrequired- ID of the invoice. Example: 4400000040000123.
messagestringrequired- The email message. May contain html. Example: Hello,<br/>please find the PDF attached..
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
subjectstringrequired- The email subject.
tostringrequired- The recipient email address. Example: someone@example.com.
attachmentsarray- A list of invoice attachment IDs to attach in the email Example: ["1050000300010040"].
sender_namestring- Sender display name Example: Acme Billing.
store_toboolean- Store the recipient address on the client contact for future use. Example: true.
elorus_invoice_email_from_templateEmail an Elorus invoice using one of the organization's email templates.WriteEmail Invoice From Template
Email an Elorus invoice using one of the organization's email templates. Returns the sent email details. Use elorus_email_templates_list to find a template ID.
Inputs
idstringrequired- ID of the invoice. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
tostringrequired- The recipient email address. Example: someone@example.com.
attach_pdfboolean- Whether to include the PDF version of the document as attachment or not. Example: true.
attachmentsarray- A list of invoice attachment IDs to attach in the email Example: ["1050000300010040"].
bccarray- A list of email addresses to blind carbon-copy the email to. Example: ["accounting@example.com"].
ccarray- A list of email addresses to carbon-copy the email to. Example: ["accounting@doe.com"].
store_toboolean- Store the recipient address on the client contact for future use. Example: true.
template_idstring- The ID of the email template to render the subject and message from. If omitted, or if it does not match an existing template, the organization's default template for the document's email type is used instead. Example: 5500000050000777.
elorus_invoice_updateUpdate fields of an Elorus invoice (PATCH).WriteUpdate Invoice
Update fields of an Elorus invoice (PATCH). Only the fields you send change. Returns the updated invoice. Use elorus_invoice_get to read current values; use elorus_invoice_void to void it.
- Idempotent
Inputs
idstringrequired- ID of the invoice. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
draftboolean- If true the document is considered to be a work in progress. Example: 0.
exchange_ratestring- Comes into effect when the currency of the transaction is different than the base currency. Will always equal 1.00 for the base currency. This field is read-only while the record is in pending approval status. Decimal rendered as string, with the . character used as a floating point. Up to 6 decimal places. Example: 1.000000.
payment_gatewaysarray- A list of payment gateway IDs that can be used to pay the invoice. Example: ["4400230020000542"].
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
elorus_product_createCreate an Elorus product or service.WriteCreate Product Or Service
Create an Elorus product or service. Returns the new product or service with its id. Use elorus_products_list to check for an existing record first.
Inputs
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
titlestringrequired- The product title. Example: Pair of socks.
activeboolean- Active Example: 1.
barcodesarray- Barcodes associated with the product or service. Example: [{"barcode": "text"}].
codestring- Optional product code, up to 40 characters. Example: PS-1.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
descriptionstring- Optional product description. Example: Super-cool expensive socks!.
initial_stockarray- Initial stock entries for warehouses. Example: [{"warehouse": "9900000050088867", "stock": "10.00"}].
manageboolean- Whether Elorus should manage the product's stock. Example: true.
purchase_taxesarray- A list of tax IDs that should apply by default when purchasing the item. Example: ["6600230050000705"].
purchase_valuestring- Default unit purchase value (this is not currency-agnostic). Decimal rendered as string, with the . character used as a floating point. Up to 5 decimal places. Example: 30.00.
purchasesboolean- Indicates if you purchase this item or not. Example: 1.
sale_taxesarray- A list of tax IDs that should apply by default when selling the item. Example: ["6600230050000705"].
sale_valuestring- Default unit sale value (this is not currency-agnostic). Decimal rendered as string, with the . character used as a floating point. Up to 5 decimal places. Example: 40.00.
salesboolean- Indicates if you sale this item or not. Example: 1.
taric_codestring- The TARIC code (TARif Intégré Communautaire; Integrated Tariff of the European Communities) is designed to show the various rules applying to specific products when imported into the EU. Example: 6115950000.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
unit_measurestring- The symbol of the corresponding unit of measurement. You may use the symbol of any custom unit, however the following options are always available: Value Description item Item service Service mm2 Square millimetre cm2 Square centimetre m2 Square metre km2 Square kilometre mm Millimetre cm Centimetre m Metre km Kilometre ml Millilitre l Litre mg Milligram gr Gram kg Kilogram t T... Example: 0.one of
itemservicemm2cm2m2km2mmcmmkmmllmggrkgtminutehourmonthyearman-hourman-dayman-monthkilowatt-hourpackageboxm3day
elorus_product_updateReplace an Elorus product or service's data (PUT): send every field you want to keep, including required ones.WriteUpdate Product Or Service
Replace an Elorus product or service's data (PUT): send every field you want to keep, including required ones. Returns the updated product or service. Use elorus_product_get to read the current values first.
- Idempotent
Inputs
idstringrequired- ID of the product or service. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
titlestringrequired- The product title. Example: Pair of socks.
activeboolean- Active Example: 1.
barcodesarray- Barcodes associated with the product or service. Example: [{"barcode": "text"}].
codestring- Optional product code, up to 40 characters. Example: PS-1.
custom_idstring- Assign a custom ID for easier identification and integration with external systems. This field is optional and can be used to reference records according to your own internal identifiers. Example: ABC-123-a1.
descriptionstring- Optional product description. Example: Super-cool expensive socks!.
manageboolean- Whether Elorus should manage the product's stock. Example: true.
purchase_taxesarray- A list of tax IDs that should apply by default when purchasing the item. Example: ["6600230050000705"].
purchase_valuestring- Default unit purchase value (this is not currency-agnostic). Decimal rendered as string, with the . character used as a floating point. Up to 5 decimal places. Example: 30.00.
purchasesboolean- Indicates if you purchase this item or not. Example: 1.
sale_taxesarray- A list of tax IDs that should apply by default when selling the item. Example: ["6600230050000705"].
sale_valuestring- Default unit sale value (this is not currency-agnostic). Decimal rendered as string, with the . character used as a floating point. Up to 5 decimal places. Example: 40.00.
salesboolean- Indicates if you sale this item or not. Example: 1.
taric_codestring- The TARIC code (TARif Intégré Communautaire; Integrated Tariff of the European Communities) is designed to show the various rules applying to specific products when imported into the EU. Example: 6115950000.
trackingcategoriesarray- An optional list of tracking categories to classify this record. Example: [{"trackingcategory": "7000230020000553", "option": "My custom tag"}].
unit_measurestring- The symbol of the corresponding unit of measurement. You may use the symbol of any custom unit, however the following options are always available: Value Description item Item service Service mm2 Square millimetre cm2 Square centimetre m2 Square metre km2 Square kilometre mm Millimetre cm Centimetre m Metre km Kilometre ml Millilitre l Litre mg Milligram gr Gram kg Kilogram t T... Example: 0.one of
itemservicemm2cm2m2km2mmcmmkmmllmggrkgtminutehourmonthyearman-hourman-dayman-monthkilowatt-hourpackageboxm3day
elorus_project_createCreate an Elorus project.WriteCreate Project
Create an Elorus project. Returns the new project with its id. Use elorus_projects_list to check for an existing record first.
Inputs
clientstringrequired- ID of the associated client. Example: 3300000040000100.
membersarrayrequired- A list of the project members. In order to track time for a project, a user must be added to the project member list. Example: [{"member": 1100000040000100, "hourly_rate": "50.00"}].
namestringrequired- The project name. Example: Web development.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
tasksarrayrequired- A list of project-specific tasks. These tasks are associated only with this particular project, unlike "global" tasks (which are not included in this list) that can be used across any project. Example: [{"name": "text"}].
billing_methodstring- The formula used to calculate project revenues based on tracked hours. Values: fixed_cost (Fixed cost), project_rate (Hourly rate), task_rate (Task hourly rate), assignee_rate (Assignee hourly rate), non_billable (Non billable).one of
fixed_costproject_ratetask_rateassignee_ratenon_billable client_portalstring- Show or hide the project in the client portal. For this setting to take effect, the client must have access to the client portal. Values: all (Show all time entries), billable (Show billable time entries), hide (Hide project).one of
allbillablehide descriptionstring- An optional description, used for your own reference. Example: Implementation.
fixed_coststring- A fixed rate for the entire project. Applies only to projects whose billing method is set to "Fixed cost". Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 500.00.
hourly_ratestring- The hourly rate of the project. Applies only to projects whose billing method is set to "Hourly rate". Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 50.00.
elorus_task_createCreate an Elorus task.WriteCreate Task
Create an Elorus task. Returns the new task with its id. Use elorus_tasks_list to check for an existing record first.
Inputs
namestringrequired- The task name. Example: Website redesign.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
activeboolean- Instead of deleting, you may archive the record. Example: 1.
descriptionstring- The task description. Example: Some text here.
hourly_ratestring- The task rate when related project's billing method is "Task hourly rate". Decimal rendered as string, with the . character used as a floating point. Up to 2 decimal places. Example: 50.00.
projectstring- ID of the associated project. Example: 7700000040000100.
elorus_time_entry_createCreate an Elorus time entry.WriteCreate Time Entry
Create an Elorus time entry. Returns the new time entry with its id. Use elorus_time_entries_list to check for an existing record first.
Inputs
assigneeintegerrequired- ID of the associated assignee. Example: 1100000040000100.
end_datetimestringrequired- Timezone information is included. Example: 2026-11-16T11:00:00+02:00.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
start_datetimestringrequired- Timezone information is included. Example: 2026-11-16T09:00:00+02:00.
billableboolean- Whether the time entry will be taken into consideration when invoicing the project. Example: true.
descriptionstring- An optional description, used for your own reference. Example: Some text here.
forcibly_billedboolean- Indicates that a time entry is forcibly marked as billed, even though it has not been associated with an invoice. Example: true.
projectstring- ID of the associated project. Example: 7700000040000100.
taskstring- ID of the associated task. Example: 7800000040000100.
user_teamstring- ID of the associated user team. When creating new time entries, if this field is not provided, it is automatically populated based on the team the assignee belongs to. Example: 1200000040000100.
elorus_time_entry_mark_billedMark an Elorus time entry as billed.WriteMark Time Entry Billed
Mark an Elorus time entry as billed. Returns the updated time entry. Use elorus_time_entries_list to find unbilled entries.
- Idempotent
Inputs
idstringrequired- ID of the time entry. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_bill_voidVoid an Elorus bill, or un-void it with void false.DestructiveVoid Bill
Void an Elorus bill, or un-void it with void false. Returns the bill with its void status. Voided documents stay on record but no longer count.
- Idempotent
Inputs
idstringrequired- ID of the bill (supplier invoice). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
voidboolean- Whether to void or un-void the document.If not sent, true will be assumed.
elorus_cash_receipt_deleteDelete an Elorus cash receipt.DestructiveDelete Cash Receipt
Delete an Elorus cash receipt. Returns an empty response. Use elorus_cash_receipts_list to find the ID.
- Idempotent
Inputs
idstringrequired- ID of the cash receipt (money received). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_contact_deleteDelete an Elorus contact.DestructiveDelete Contact
Delete an Elorus contact. Returns an empty response. Use elorus_contacts_list to find the ID.
- Idempotent
Inputs
idstringrequired- ID of the contact (client or supplier). Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_credit_note_voidVoid an Elorus credit note, or un-void it with void false.DestructiveVoid Credit Note
Void an Elorus credit note, or un-void it with void false. Returns the credit note with its void status. Voided documents stay on record but no longer count.
- Idempotent
Inputs
idstringrequired- ID of the credit note. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
voidboolean- Whether to void or un-void the document.If not sent, true will be assumed.
elorus_estimate_deleteDelete an Elorus estimate.DestructiveDelete Estimate
Delete an Elorus estimate. Returns an empty response. Use elorus_estimates_list to find the ID.
- Idempotent
Inputs
idstringrequired- ID of the estimate. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_expense_deleteDelete an Elorus expense.DestructiveDelete Expense
Delete an Elorus expense. Returns an empty response. Use elorus_expenses_list to find the ID.
- Idempotent
Inputs
idstringrequired- ID of the expense. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_invoice_deleteDelete an Elorus invoice.DestructiveDelete Invoice
Delete an Elorus invoice. Returns an empty response. Use elorus_invoices_list to find the ID.
- Idempotent
Inputs
idstringrequired- ID of the invoice. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
elorus_invoice_voidVoid an Elorus invoice, or un-void it with void false.DestructiveVoid Invoice
Void an Elorus invoice, or un-void it with void false. Returns the invoice with its void status. Voided documents stay on record but no longer count.
- Idempotent
Inputs
idstringrequired- ID of the invoice. Example: 4400000040000123.
organization_idstringrequired- ID of the Elorus organization to act on, sent as the X-Elorus-Organization header. Find it in Elorus under Settings > Organization (the ID shown in the API section) or in the web app URL. Example: 1234567890123456.
voidboolean- Whether to void or un-void the document.If not sent, true will be assumed.
No tools match.