Daftra MCP by usefulapi

The Daftra account this API key belongs to: id, business name, subdomain, country, timezone, date format, default currency and subscription expiry. Check the date format and currency here before creating records. GET /site_info.

無需輸入參數。

List clients (customers), 20 per page by default. Search by name, number, email or phone with `keywords`. Each item is wrapped in a `Client` object. GET /clients.

One client by id (contact details, balance settings, currency, address). GET /clients/{id}.

List sales invoices (and debit notes), most recent first. Filter by client, payment status, dates or free text. By default each item has the header and client; set recursive=1 for line items, payments and taxes. GET /invoices.

One standard invoice by id with line items, payments, taxes, custom fields and client. Other document types (estimate, credit note) answer 404. GET /invoices/{id}.

List estimates (quotes), most recent first. Filter by client, status, dates or free text. GET /estimates.

One estimate (quote) by id with line items, taxes and client. GET /estimates/{id}.

List payments recorded against invoices, most recent first. Opening-balance and client-credit payments are excluded. GET /invoice_payments.

List payments received from clients, most recent first. Opening-balance and client-credit payments are excluded. GET /client_payments.

List products and services (name, code, price, stock) ordered by name. Search by name, code, barcode or tag with `keywords`. Each item is a `Product` object. GET /products.

One product by id with images and categories. GET /products/{id}.

List product categories with their parent category. GET /product_categories.

List stores (warehouses) the key's user may view. Use the ids to filter stock transactions. GET /stores.

List processed stock movements (in, out, transfers), most recent first. Filter by product, store or date range. GET /stock_transactions.

List treasuries and bank accounts the key's user may view, with balances. Use the ids when recording expenses. GET /treasuries.

List expenses (money out), most recent first, with amount, vendor, category and treasury. Filter by dates, amount, category, vendor or status. GET /expenses.

One expense by id. GET /expenses/{id}.

List incomes (money in that is not an invoice payment), most recent first. Same filters as expenses. GET /incomes.

List the taxes configured for the account (name, rate, active). Use the ids as tax1/tax2 on invoice lines. All taxes come in one reply. GET /taxes.

List purchase invoices (bills from suppliers), most recent first. Search by supplier or filter by payment status. GET /purchase_invoices.

One purchase invoice by id with line items, supplier, taxes and payments. GET /purchase_invoices/{id}.

List suppliers. Filter by name, address, postal code, country or status. GET /suppliers.

One supplier by id. GET /suppliers/{id}.

List notes recorded against clients, invoices, estimates, purchase invoices, staff, suppliers, products and work orders: text, the record it belongs to (item_type + item_id), author, follow-up status. GET /notes.

WRITE: create a client (customer). Only business_name is required. Without an email the client is created as offline (no email sending). Returns the new client's id and client_number. POST /clients.

WRITE: change fields of an existing client. Partial update: only the fields you pass change; business_name cannot be emptied. PUT /clients/{id}.

WRITE: create a supplier. business_name is required; email is required unless is_offline is true. Returns the new supplier's id. POST /suppliers.

WRITE: record an expense (money out of a treasury). amount and date are required; the treasury defaults to the primary one and the currency to the account currency. Pass unique_id so a retry cannot create it twice. Returns the new expense id and number. POST /expenses.

WRITE: create a sales invoice for a client with line items. It is saved as a DRAFT unless you pass draft=false; a final invoice posts to the books and stock. Returns the new invoice id. POST /invoices.

WRITE: add a note to a client, invoice, estimate, purchase invoice, supplier, product, staff member or work order. The note is private unless share_with_partner is true. POST /notes/{type}/{id}.