calcubox-core

List Contacts

Returns all contacts for a company. Optionally filter by type: C = customer, P = provider.

Search Contacts

Full-text search for contacts by name, taxKey, or email. Optionally filter by type: C = customer, P = provider.

Get Contact

Returns a single contact by ID.

Create Contact

Creates a new contact for a company.

List Transactions

Returns all transactions for a company within a date range. startDate is required. Filter by contactId or toAccountId — type and fromAccountId are not currently filterable.

Get Transaction

Returns a single transaction by its internal _id.

Create Transaction

Creates a new INPUT or OUTPUT transaction for a company. Requires type, value, fromAccountId, toAccountId, and date (ISO 8601 string). If contact._id is omitted, a new contact is always created — there is no fuzzy name-matching against existing contacts. Only omit it when you have confirmed with the user this is genuinely a new contact. Use create_transference instead for moving money between this company's own accounts.

Create Transference

Moves money between two of this company's own accounts, creating a paired pair of transactions (TRANSFERENCE_INPUT/TRANSFERENCE_OUTPUT) linked by a shared sequence. Requires value, fromAccountId, toAccountId, and date (ISO 8601 string). Use this instead of create_transaction for internal transfers — creating TI/TO legs individually would leave them unpaired.

List Items

Returns all items for a company. Optionally filter by status.

Search Items

Full-text search for items by name, SKU, or supplier code. Optionally filter by status or isSellable.

Get Item

Returns a single item by ID.

Create Item

Creates a new item for a company. Requires name, isSellable, and at least one variant with stock and salePrice.

Update Item

Updates an existing item. Only provided fields are updated.

List Estimates

Returns all estimates for a company. Filter by contactId, itemId, or date range — status is not currently filterable.

Get Estimate

Returns a single estimate by ID.

Create Estimate

Creates a new estimate for a company. Requires date (ISO 8601 string), contact, and items with description, quantity, price per line (taxId optional, for untaxed items). If contact._id is omitted, a new contact is always created — there is no fuzzy name-matching against existing contacts. Only omit it when you have confirmed with the user this is genuinely a new contact.

List Sales

Returns all sales for a company. Filter by contactId, itemId, or date range — status and invoiced are not currently filterable. Each result includes both _id (internal identifier — use it for get_sale) and code (human-facing sale number — use it when talking to the user). There is no filter by code.

Get Sale

Returns a single sale by its internal _id. When reporting the sale back to the user, refer to it by its code, not its _id.

Create Sale

Creates a new sale for a company. Requires date (ISO 8601 string), contact, and items with description, quantity, price per line (taxId optional, for untaxed items). If contact._id is omitted, a new contact is always created — there is no fuzzy name-matching against existing contacts. Only omit it when you have confirmed with the user this is genuinely a new contact.

List Purchases

Returns all purchases for a company. Filter by contactId, itemId, or date range.

Get Purchase

Returns a single purchase by ID.

Create Purchase

Creates a new purchase for a company. Requires date (ISO 8601 string), contact, and items with description, quantity, price per line (taxId optional, for untaxed items). If contact._id is omitted, a new contact is always created — there is no fuzzy name-matching against existing contacts. Only omit it when you have confirmed with the user this is genuinely a new contact.

Update Purchase

Updates an existing purchase. Only provided fields are updated. If contact is provided without contact._id, a new contact is always created — there is no fuzzy name-matching against existing contacts. Only send contact without an _id when you have confirmed with the user this is genuinely a new contact.