Billabex

Create a new customer account for an organization. Requires full account details including billing address and currency.

Add a new contact to a customer account. Contacts are external people who can receive dunning emails. One of fullName or email is required; an email address alone is enough.

Create a new credit note with an attached document. The file should be provided as base64-encoded content. Supported formats: PDF, PNG, JPEG, WebP. Max size: 10MB.

Create a new invoice with an attached document file. The file must be provided as base64-encoded data. Supported formats: PDF, PNG, JPEG, WebP. Max size: 10MB.

Invite a user to an organization by email address. Existing active users join immediately. Otherwise the invitation expires automatically after seven days.

Create a new label owned by an organization. Check list-tags first, an equivalent label may already exist.

Permanently delete a customer account and all associated data. This action cannot be undone. Accounts linked to external sources may have restrictions.

Remove a contact from a customer account.

Permanently delete a credit note.

Permanently delete an invoice. This action cannot be undone. The invoice must not be linked to a managed account source.

Buy a contact's details: 1 credit for an email address, 2 as soon as a phone number is found, 0 when nothing is found. SPENDS THE ORGANIZATION'S CREDITS, so confirm with the user before calling it. The search must be anchored on the debtor: either a LinkedIn profile URL, or a company domain on the account. Without one of the two it is refused before any spend, because a name alone matches a namesake company anywhere in the world. Returns as soon as the provider accepted; the contact appears on the account about a minute later, on its own, and nothing has to be polled.

Retrieve detailed information about a specific customer account including contacts and source information. For user-facing responses, prefer account name/summary fields and use IDs only for follow-up tool calls.

Read the payment follow-up status of a customer account: whether it is suspended and why, whether a task or a threshold is holding messages back, and when the first message becomes possible. Answer questions about a silent account with this: `silenceReason` names the single cause, ranked the same way the send decision ranks it. Read-only, it changes nothing on the account.

Explain a customer account balance and list every past and future invoice installment, including covered installments and the amount still due on each one.

Read the commitment to pay currently standing on an account. Returns null when none does. A promise changes no accounting: it is what the next follow-up must not contradict.

Get detailed information about a specific account task including its type, status, and required input.

Get net outstanding amounts by currency and aging bucket. Unallocated credit notes reduce the oldest buckets first.

Retrieve detailed information about a specific contact.

Get detailed information about a specific credit note by ID, or by organization/account ID and credit note number. A credit note number is only unique within an account, so organizationId+number may answer any one of several credit notes sharing that number across accounts: pass accountId+number whenever the account is known. For user-facing responses, prefer credit note number/summary fields and use IDs only for follow-up tool calls.

Get detailed information about a specific customer outstanding balance, including associated invoices and credit notes.

Get days sales outstanding for complete calendar months. Historical ECB rates, with blended rates for unsupported pairs. Rate errors never return partial totals.

Get detailed information about a specific incoming email communication, including the email content.

Get detailed information about a specific incoming email, including the simplified body content (text or HTML converted to markdown).

Read an incoming email’s current inbox qualification, account and review task in one organization. Use emailId from list-incoming-emails and get-incoming-email for its content. Unclassified may have a resolved account but is not a customer reply; DeliveryFailure reports an email that could not be delivered to at least one recipient and may have a resolved account. PendingReview carries a candidate account and Rejected a rejected association. A deleted account retains its name but cannot be opened.

Retrieve detailed information about a specific invoice by its ID, or by organization/account ID and invoice number. An invoice number is only unique within an account, so organizationId+number may answer any one of several invoices sharing that number across accounts: pass accountId+number whenever the account is known. For user-facing responses, prefer invoice number/summary fields and use IDs only for follow-up tool calls.

Get monthly payment collections including the current month. Historical ECB rates, with blended rates for unsupported pairs. Rate errors never return partial totals.

Get the authenticated user notification preferences.

Get detailed information about a specific organization by its ID, including credits, the prepaid balance for the SMS and postal letter reminders Billabex sends, and creditLots, when each top-up expires. Emails are free and never consume it. At zero, those two channels stop. Credits expire twelve months after they are loaded, so check creditLots before telling a user how long their balance lasts. For user-facing responses, prefer organization name/summary fields and use IDs only for follow-up tool calls.

Get an outgoing email communication and its content. A task email with awaitingApproval true is only prepared; use its taskId and the DecideOutgoingEmailDraft task interaction to send or discard it.

Get detailed information about a specific outgoing email, including the simplified body content (text or HTML converted to markdown).

Get a sent SMS or postal message, its latest delivery status and a short-lived pdfUrl for its archived letter when available. Read again to renew an expired URL.

Link a custom source reference to an account. This connects the Billabex account to an external system (ERP, CRM, etc.) for synchronization purposes. Only Custom sources can be linked by users.

Read reported payments and explicit decisions. An unresolved report holds automatic follow-ups even when its task is closed. `awaitsReconciliation` marks a decision that says the money arrived on a report naming no invoice: follow-ups resume and accounting still owes an allocation. `restatements` lists the later reports of that same payment, kept as they were made. `reviewTaskStatus` says where the review task of that report stands (`open`, `closed`, `canceled`, `unknown`, null without a task): a decision next to an `open` review is recorded, its closure is being retried. `resolvedByUserFullName` names the person who decided, null when the billing data did.

List account tasks of an organization, with server-side filtering, sorting and pagination. Tasks are created by the Billabex agent when it needs information from the user (approving eligibility, selecting a next action, providing contacts). For user-facing responses, prefer the task title/summary fields and use IDs only for follow-up tool calls. Filterable fields and their operators: title (contains, startsWith, equals), accountName (contains, startsWith, equals), status (is, isNot, isAnyOf: Open, InProgress, UserActionRequired, Closed, Canceled, Pending), type (is, isNot, isAnyOf: ApproveEligibility, ApproveContactChange, ApprovePaymentArrangement, NeedContacts, AskNextAction, ApproveFirstOutreach, NeedUserInput, PaymentScheduleInvalidated, Notice, Unknown), tags (containsAny, containsAll, containsNone, isEmpty, isNotEmpty), balance (equals, greaterThan, lessThan, between, isEmpty, isNotEmpty), createdAt (on, before, after, between), updatedAt (on, before, after, between, isEmpty, isNotEmpty). Date values are written YYYY-MM-DD. An unknown field or an operator the field does not accept is refused, never ignored. An "endCursor" belongs to the exact set of filters and sort it was issued for: pass it back unchanged, and read the list again from its first page whenever a filter or the sort changes. Contract change: this tool used to take a required accountId, return every active task of that account in one shot and never paginate. It now takes organizationId, returns tasks of any status by default (filter on status to narrow), and pages. Its "type" argument became a "type" filter condition, and accountId became optional.

List customer accounts from the fast account projection, with search, filtering and sorting. Returns lightweight financial and follow-up fields, including source.sourceId as the external customer reference for connector-linked accounts. Use get-account for contacts, address, and full details. Filterable fields: `accountName` (contains, startsWith, equals); `tags` (containsAny, containsAll, containsNone, isEmpty, isNotEmpty); `dunningPaused` (isTrue, isFalse); `collectionStatus` (is, isNot, isAnyOf: Open, Settled, WrittenOff, NoInvoice); `daysOverdue`, `overdueInvoiceCount`, `overdueBalance`, `remainingBalance` (equals, greaterThan, lessThan, between); `hasPaymentSchedule` (isTrue, isFalse); `paymentMethod` (is, isNot, isAnyOf, isEmpty, isNotEmpty); `collectiveProceeding` (is, isNot, isAnyOf: Yes, No, Unknown); `source` (is, isNot, isAnyOf, isEmpty, isNotEmpty). A cursor belongs to the exact set of filters and sort it was issued with: reusing it with different ones is refused, drop "after" and read the first page again.

List currency-specific aging balance rows by customer account, with filtering and sorting. Filterable fields: `accountName` (contains, startsWith, equals); `tags` (containsAny, containsAll, containsNone, isEmpty, isNotEmpty); `dunningPaused` (isTrue, isFalse); `paymentMethod` (is, isNot, isAnyOf, isEmpty, isNotEmpty); `collectiveProceeding` (is, isNot, isAnyOf: Yes, No, Unknown); `source` (is, isNot, isAnyOf, isEmpty, isNotEmpty); `notDue`, `d0_30`, `d31_60`, `d61_90`, `d90Plus`, `totalOutstanding`, `overdueOutstanding`, `overdueRate` (equals, greaterThan, lessThan, between). A cursor belongs to the exact set of filters and sort it was issued with: reusing it with different ones is refused, drop "after" and read the first page again.

List the audit journal of an organization, newest first: one entry per successful command, with the user, agent or system that ran it. Pass accountId for the history of a single account, which is also the only way to read the history of an account that has been deleted. Use search to find an account by name: the name survives in the metadata of the commands that touched it, never in the account list once it is gone.

List communications (incoming and outgoing emails) for an organization from the fast pre-joined projection, with server-side filters, sorting and pagination. Prefer this over list-incoming-communications/list-outgoing-communications when you need filtering or are scanning many communications. Use get-incoming-communication/get-outgoing-communication for the full email body. Filterable fields and their operators: direction (is, isNot, isAnyOf: Incoming, Outgoing), status (is, isNot, isAnyOf), deliveryStatus (is, isNot, isAnyOf, isEmpty, isNotEmpty), accountName / contactName / subject (contains, startsWith, equals, isEmpty, isNotEmpty), date (on, before, after, between). Date values are written YYYY-MM-DD. An unknown field or an operator the field does not accept is refused, never ignored. An "endCursor" belongs to the exact set of filters and sort it was issued for: pass it back unchanged, and read the list again from its first page whenever a filter or the sort changes.

List all contacts associated with a customer account. Contacts are the external people (customers) who can receive dunning communications. For user-facing responses, prefer contact name/summary fields and use IDs only for follow-up tool calls.

List credit notes for an organization, with server-side filtering, sorting and pagination. Items carry the full credit note (tax, credit allocations, billing address, PDF) plus the account payment method. For user-facing responses, prefer credit note number/summary fields and use IDs only for follow-up tool calls. Filterable fields: `number` (contains, startsWith, equals, isAnyOf: several document numbers in one condition); `accountName` (contains, startsWith, equals); `tags` (containsAny, containsAll, containsNone, isEmpty, isNotEmpty: the labels carried by the account this document belongs to); `status` (is, isNot, isAnyOf: Issued, PartiallySettled, Settled); `issuedDate` (on, before, after, between); `paymentMethod` (is, isNot, isAnyOf, isEmpty, isNotEmpty); `totalAmount`, `remainingAmount` (equals, greaterThan, lessThan, between); `channel` (is, isNot, isAnyOf); `sourceId` (is, isAnyOf, isEmpty, isNotEmpty: case-sensitive, the caller-provided identifier). A cursor belongs to the exact set of filters and sort it was issued with: reusing it with different ones is refused, drop "after" and read the first page again.