Account 9
create_account
Create a chart-of-accounts (GL) account. accountClass is an AdmCloud account class (e.g. Cash, Bank, CustomerReceivables, VendorPayables, Income, Expense, FixedAssets); the account type is derived from it. Returns the new id.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Account name. Required. |
code | text | No | Account code. Optional (may be auto-generated). |
accountClass | text | Sí | Account class name (AccountClassEnum value, e.g. Cash, Bank, Income, Expense). Required. |
currencyID | text | No | Currency id (e.g. DOP, USD). Optional. |
delete_account
Delete a chart-of-accounts (GL) account by its id. Blocked by the system when it has movements or is in use. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
id | id (guid) | Sí | Account id (Guid). |
get_account
Get a chart-of-accounts (GL) account by its id.
| Parámetro | Tipo | Requerido | Descripción |
|---|
id | id (guid) | Sí | Account id (Guid). |
get_account_balance
Get the accumulated balance (saldo) of a single general-ledger account, found by its code or name. The balance is the sum of debits minus credits of all posted transactions, sign-normalized by the account nature (so liabilities, equity and revenue show a positive natural balance). If the account is a parent/group account its child accounts are included. The amount is returned in the company's local currency.
| Parámetro | Tipo | Requerido | Descripción |
|---|
accountName | text | Sí | Account code or name to search for |
get_account_movement
Get the movement (debits minus credits) of a single general-ledger account, found by its code or name, for a year. Pass month 0 for the whole year, or 1-12 for a single month. Returns total debits, total credits and the net movement (debits - credits, which may be negative). If the account is a parent/group account its child accounts are included. Amounts are in the company's local currency.
| Parámetro | Tipo | Requerido | Descripción |
|---|
accountName | text | Sí | Account code or name to search for |
year | integer | Sí | The year |
month | integer | Sí | The month (1-12), or 0 for the whole year |
get_expenses_by_month
Get total expenses broken down by month for a year.
| Parámetro | Tipo | Requerido | Descripción |
|---|
year | integer | Sí | The year |
get_expenses_by_month_for_account
Get monthly expenses for a single account, found by code or name, for a year.
| Parámetro | Tipo | Requerido | Descripción |
|---|
year | integer | Sí | The year |
accountName | text | Sí | Account code or name to search for |
get_top10_expenses_by_account
Get the 10 largest expenses of a year, grouped by general-ledger account.
| Parámetro | Tipo | Requerido | Descripción |
|---|
year | integer | Sí | The year |
search_accounts
List chart-of-accounts (GL) accounts by code or name (empty for all). Returns the first 50 non-group accounts with id, code, name, class and currency.
| Parámetro | Tipo | Requerido | Descripción |
|---|
search | text | No | Code or name filter (or part of it). Leave empty for all. |
Accounting Statements 5
get_balance_sheet
Get the balance sheet (assets, liabilities and equity with account detail) as of a date, in the company currency. Period results are included in equity, like the native report.
| Parámetro | Tipo | Requerido | Descripción |
|---|
dateTo | text | No | Cut-off date (inclusive) in yyyy-MM-dd format. Leave empty for today. |
get_general_ledger
Get general-ledger journal entries for a period, in the company currency. Without an account, pass a month 1-12 and the 100 most recent lines are returned. With an account (by code or name), its entries are listed chronologically and month 0 covers the whole year.
| Parámetro | Tipo | Requerido | Descripción |
|---|
year | integer | Sí | The year |
month | integer | Sí | The month (1-12). Only with an account it can be 0 for the whole year. |
accountName | text | No | Account code or name to drill into a single account. Leave empty for all accounts. |
get_results
Get the income statement (revenue, costs, gross margin, expenses, net margin and result) for a year. Pass month 0 for the whole year, or 1-12 for a single month.
| Parámetro | Tipo | Requerido | Descripción |
|---|
year | integer | Sí | The year |
month | integer | Sí | The month (1-12), or 0 for the whole year |
get_results_by_month
Get the income statement (revenue, costs, expenses, net result) broken down by month for a year.
| Parámetro | Tipo | Requerido | Descripción |
|---|
year | integer | Sí | The year |
get_trial_balance
Get the trial balance (initial balance, debits, credits and final balance per account) for a period, in the company currency. Pass month 0 for the whole fiscal year, or 1-12 for a single month.
| Parámetro | Tipo | Requerido | Descripción |
|---|
year | integer | Sí | The year |
month | integer | Sí | The month (1-12), or 0 for the whole fiscal year |
Credit Memos 4
create_credit_memo
Create a customer credit memo (credit note) for a customer (by name) for one item (by SKU or name) and quantity. Fiscal numbering (NCF), taxes and posting are handled by the system. Returns a link to the created credit memo.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | Sí | Customer name (or part of it) |
itemSkuOrName | text | Sí | Item SKU or name |
quantity | number | Sí | Quantity to credit |
notes | text | No | Optional notes / observations to store on the document. |
delete_credit_memo
Delete a customer credit memo by its document number. Reverses posting/stock through the system and is blocked when it has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Credit memo document number (DocID) |
get_credit_memo
Get the full detail of a single customer credit memo by its document number, including header (customer, currency, total) and line items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Credit memo document number (DocID) |
search_credit_memos
List customer credit memos with optional filters by customer name and date range. Returns the 50 most recent matches with document id, date, customer, currency and total.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | No | Customer name (or part of it) to filter by. Leave empty for all customers. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
Customers 7
create_customer
Create a new customer. Only the name is required; all other fields are optional. Returns the new customer id.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Customer (company) name. Required. |
code | text | No | Customer code/identifier. Leave empty to auto-generate when the company is configured for it. |
comercialName | text | No | Commercial / trade name. Optional. |
email | text | No | Email address. Optional. |
phone1 | text | No | Phone number. Optional. |
fiscalID | text | No | Tax id (RNC/Cédula/Fiscal ID). Optional. |
currencyID | text | No | Currency id (e.g. DOP, USD). Optional; defaults to the company currency when empty. |
priceLevelName | text | No | Price level name, which sets the customer's selling prices. Leave empty to use the company's default price level, or the only one when the company has a single price level; if the company has several and no default, the call reports the available names so you can pick one. |
delete_customer
Delete a customer by its id. Fails when the customer has linked records (transactions, budgets, etc.).
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerId | id (guid) | Sí | Id of the customer to delete. Required. |
get_aged_receivables
Get the accounts-receivable aging report summarized by customer, in the company currency. Buckets are 30-day periods since the document date (0-30, 31-60, 61-90, over 90). Lists the top 50 customers by balance.
Sin parámetros.
get_customer_balance
Find a customer by name and return their accounts-receivable balance and overdue amount in the company currency.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Customer name (or part of it) to look up |
get_customer_info
Find a customer by name and return their profile (currency, sales rep, payment terms, discount) together with their contacts. Returns matches when the name is ambiguous.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Customer name (or part of it) to look up |
search_customers
Search customers by name, code or fiscal ID and return a summary list (top 20 matches). Pass an empty search to list the first 20 customers.
| Parámetro | Tipo | Requerido | Descripción |
|---|
search | text | No | Text to search for in the customer name, code or fiscal ID. Empty returns the first 20 customers. |
update_customer
Update an existing customer by its id. Only the fields you pass are changed; leave a field empty to keep its current value.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerId | id (guid) | Sí | Id of the customer to update. Required. |
name | text | No | New name. Leave empty to keep the current value. |
code | text | No | New code. Leave empty to keep the current value. |
comercialName | text | No | New commercial / trade name. Leave empty to keep the current value. |
email | text | No | New email. Leave empty to keep the current value. |
phone1 | text | No | New phone number. Leave empty to keep the current value. |
fiscalID | text | No | New tax id (RNC/Cédula/Fiscal ID). Leave empty to keep the current value. |
currencyID | text | No | New currency id (e.g. DOP, USD). Leave empty to keep the current value. |
Inventory 7
create_item
Create an inventory item. SKU and name are required (SKU may be left empty when the company auto-numbers items). The unit-of-measure conversion plan and unit are picked automatically when the company has only one of each; otherwise pass their names. Returns the new item id.
| Parámetro | Tipo | Requerido | Descripción |
|---|
sku | text | No | Item SKU / code. Leave empty only when the company is configured to auto-number items. |
name | text | Sí | Item name / description. Required. |
itemClassName | text | No | Item class name. Optional. |
uomPlanName | text | No | Unit-of-measure conversion plan name. Optional: required only when the company has more than one plan. |
uomName | text | No | Unit of measure name, used as the report, purchase and sales unit. Optional: required only when the conversion plan has more than one unit. |
salesDescription | text | No | Sales description shown on sales documents. Optional. |
purchaseDescription | text | No | Purchase description shown on purchase documents. Optional. |
salesItem | boolean | No | Whether the item can be sold. Optional, defaults to true. |
purchaseItem | boolean | No | Whether the item can be purchased. Optional, defaults to true. |
stockItem | boolean | No | Whether the item is included in stock control. Optional, defaults to true. |
delete_item
Delete an inventory item by its id. Blocked by the system when the item has linked records (transactions, stock, kits, price lists). This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
itemId | id (guid) | Sí | Id of the item to delete (Guid). Required. Get it from search_items. |
get_item
Get the detail of a single item by SKU or name (unique match), including item type and units of measure.
| Parámetro | Tipo | Requerido | Descripción |
|---|
skuOrName | text | Sí | Item SKU or name (or part of it) |
get_items_low_stock
Get items whose stock has fallen to or below their reorder level, per location.
| Parámetro | Tipo | Requerido | Descripción |
|---|
filterBySubsidiary | boolean | Sí | When true, only consider items assigned to the signed-in subsidiary |
get_item_stock
Get the stock on hand for an item (by SKU or name) at a location (by name).
| Parámetro | Tipo | Requerido | Descripción |
|---|
itemName | text | Sí | Item SKU or name to search for |
locationName | text | Sí | Location name to search for |
search_items
Search inventory items and services by SKU or name and return a summary list (top 20 matches). Pass an empty search to list the first 20 items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
search | text | No | Text to search for in the item SKU or name. Empty returns the first 20 items. |
includeInactive | boolean | Sí | When true, inactive items are included in the results. |
update_item
Update an inventory item by its id. Only the fields you pass are changed; leave a field empty to keep its current value. The conversion plan cannot be changed here because it would invalidate existing stock.
| Parámetro | Tipo | Requerido | Descripción |
|---|
itemId | id (guid) | Sí | Id of the item to update (Guid). Required. Get it from search_items. |
sku | text | No | New SKU / code. Leave empty to keep the current value. |
name | text | No | New name / description. Leave empty to keep the current value. |
itemClassName | text | No | New item class name. Leave empty to keep the current value. |
uomName | text | No | New unit of measure name, applied to the report, purchase and sales unit. Must belong to the item's existing conversion plan. Leave empty to keep the current units. |
salesDescription | text | No | New sales description. Leave empty to keep the current value. |
purchaseDescription | text | No | New purchase description. Leave empty to keep the current value. |
salesItem | boolean | No | Whether the item can be sold. Leave empty to keep the current value. |
purchaseItem | boolean | No | Whether the item can be purchased. Leave empty to keep the current value. |
stockItem | boolean | No | Whether the item is included in stock control. Leave empty to keep the current value. |
inactive | boolean | No | Whether the item is inactive. Leave empty to keep the current value. |
Invoices 4
create_invoice
Create a credit (on-account) sales invoice for a customer (by name) for one item (by SKU or name) and quantity. Fiscal numbering (NCF), taxes and posting are handled by the system. Returns a link to the created invoice.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | Sí | Customer name (or part of it) |
itemSkuOrName | text | Sí | Item SKU or name |
quantity | number | Sí | Quantity to invoice |
notes | text | No | Optional notes / observations to store on the document. |
delete_invoice
Delete a credit sales invoice by its document number. Reverses posting/stock through the system and is blocked when the invoice has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Invoice document number (DocID) |
get_invoice
Get the full detail of a single credit sales invoice by its document number, including header (customer, currency, total, pending balance) and line items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Invoice document number (DocID), e.g. the value shown as the document id in search_invoices. |
search_invoices
List credit (on-account) sales invoices with optional filters by customer name, date range and open-balance only. Cash sales are in search_sales_receipts. Returns the 50 most recent matches with document id, date, customer, total and pending balance.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | No | Customer name (or part of it) to filter by. Leave empty for all customers. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
onlyOpen | boolean | Sí | When true, only invoices with a pending balance are returned. |
Kits 5
create_kit
Create a kit. The name and at least one component are required, and so is the SKU unless the company is configured to auto-number kits. Components that require lots or serial numbers, or that have attributes, are rejected by the system and must be handled from the Kits screen. Returns the new kit id.
| Parámetro | Tipo | Requerido | Descripción |
|---|
sku | text | No | Kit SKU / code. Leave empty only when the company is configured to auto-number kits. |
name | text | Sí | Kit name / description. Required. |
components | list of ComponentInput | Sí | Items and services that make up the kit. At least one is required. |
itemClassName | text | No | Item class name. Optional. |
salesDescription | text | No | Sales description shown on sales documents. Optional. |
showComponents | boolean | No | Show the kit components on transactions. Optional, defaults to false. |
allowComponentsQuantityChange | boolean | No | Allow changing component quantities on transactions. Optional, defaults to false. Turning this on also shows the components. |
pricesOnKitComponents | boolean | No | Handle prices at component level instead of at kit level. Optional, defaults to false. Requires showComponents to be true. |
delete_kit
Delete a kit by its id. Blocked by the system when the kit has linked records (transactions, price lists). Deleting a kit does not delete its component items. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
kitId | id (guid) | Sí | Id of the kit to delete (Guid). Required. Get it from search_kits. |
get_kit
Get a kit by its id, including its component items with quantities and units of measure.
| Parámetro | Tipo | Requerido | Descripción |
|---|
kitId | id (guid) | Sí | Kit id (Guid). Get it from search_kits. |
search_kits
Search kits by SKU or name and return a summary list (top 20 matches). Pass an empty search to list the first 20 kits.
| Parámetro | Tipo | Requerido | Descripción |
|---|
search | text | No | Text to search for in the kit SKU or name. Empty returns the first 20 kits. |
includeInactive | boolean | No | Include inactive kits in the result. Optional, defaults to false. |
update_kit
Update a kit by its id. Only the fields you pass are changed; leave a field empty to keep its current value. Passing components REPLACES the whole component list, so send every component the kit should end up with; omit it to keep the current components.
| Parámetro | Tipo | Requerido | Descripción |
|---|
kitId | id (guid) | Sí | Id of the kit to update (Guid). Required. Get it from search_kits. |
sku | text | No | New SKU / code. Leave empty to keep the current value. |
name | text | No | New name / description. Leave empty to keep the current value. |
components | list of ComponentInput | No | Full replacement list of items and services that make up the kit. Omit to keep the current components; an empty list is rejected because a kit needs at least one component. |
itemClassName | text | No | New item class name. Leave empty to keep the current value. |
salesDescription | text | No | New sales description. Leave empty to keep the current value. |
showComponents | boolean | No | Show the kit components on transactions. Leave empty to keep the current value. |
allowComponentsQuantityChange | boolean | No | Allow changing component quantities on transactions. Leave empty to keep the current value. |
pricesOnKitComponents | boolean | No | Handle prices at component level. Leave empty to keep the current value. Requires showComponents to be true. |
inactive | boolean | No | Whether the kit is inactive. Leave empty to keep the current value. |
Opportunities 5
create_opportunity
Create a new CRM sales opportunity (lead) with a name, phone and contact. Returns a link to the created opportunity.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Name of the opportunity |
phone | text | Sí | Phone number for the lead |
contact | text | Sí | Contact person for the lead |
delete_opportunity
Delete a sales opportunity by its id. Fails when the opportunity has linked records (transactions). This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
id | id (guid) | Sí | Opportunity id (Guid). |
get_opportunities_to_contact
Get open sales opportunities that are overdue for follow-up (no recent contact within the reminder window).
Sin parámetros.
get_opportunity
Get a sales opportunity by its id (name, contact, customer, sales stage, revenue and document date).
| Parámetro | Tipo | Requerido | Descripción |
|---|
id | id (guid) | Sí | Opportunity id (Guid). |
search_opportunities
Search sales opportunities by name, contact, phone, e-mail or customer name and return a summary list (top 20 matches). Pass an empty search to list the most recent opportunities.
| Parámetro | Tipo | Requerido | Descripción |
|---|
search | text | No | Text to search for in the opportunity name, contact, phone, e-mail or customer name. Empty returns the most recent opportunities. |
Payment Documents 5
create_payment
Record a customer payment as an advance/prepayment (NOT applied to specific invoices) for a given amount. The money is received into the given cash account (by name or code), or the default cash account when omitted. The document currency is that account's currency.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | Sí | Customer name (or part of it) |
amount | number | Sí | Amount received, in the cash account's currency |
cashAccount | text | No | Cash/bank account name or code to receive the money. Leave empty to use the single default cash account. |
notes | text | No | Optional notes / observations to store on the document. |
delete_payment
Delete a customer advance/prepayment by its document number. Reverses posting through the system and is blocked when it has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Payment (advance/prepayment) document number (DocID) |
get_payment
Get the detail of a single customer payment (advance/prepayment or cash receipt) by its document number.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Payment document number (DocID) |
get_pending_payments_to_authorize
Get the count of payments that are pending authorization.
Sin parámetros.
search_payments
List customer payments (cash receipts) with optional filters by customer name and date range. Returns the 50 most recent matches with document id, date, customer, reference and amount.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | No | Customer name (or part of it) to filter by. Leave empty for all customers. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
Purchase Orders 5
create_purchase_order
Create a purchase order for a vendor (by name) for one item (by SKU or name), quantity and unit cost. A purchase order does not post to the ledger or move inventory. Returns a link to the created order.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorName | text | Sí | Vendor name (or part of it) |
itemSkuOrName | text | Sí | Item SKU or name |
quantity | number | Sí | Quantity to order |
unitCost | number | Sí | Unit cost in the vendor's currency |
notes | text | No | Optional notes / observations to store on the document. |
delete_purchase_order
Delete a purchase order by its document number. Blocked by the system when the order has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Purchase order document number (DocID) |
get_pending_purchase_orders_to_authorize
Get the count of purchase orders that are pending authorization.
Sin parámetros.
get_purchase_order
Get the full detail of a single purchase order by its document number, including header (vendor, currency, total) and line items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Purchase order document number (DocID) |
search_purchase_orders
List purchase orders with optional filters by vendor name and date range. Returns the 50 most recent matches with document id, date, vendor, currency and total.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorName | text | No | Vendor name (or part of it) to filter by. Leave empty for all vendors. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
Sales Orders 5
create_sales_order
Create a sales order for a customer (by name) for one item (by SKU or name) and quantity. Requires a single predefined sales location. Returns a link to the created order.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | Sí | Customer name (or part of it) |
itemSkuOrName | text | Sí | Item SKU or name |
quantity | number | Sí | Quantity to order |
notes | text | No | Optional notes / observations to store on the document. |
delete_sales_order
Delete a sales order by its document number. Blocked by the system when the order has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Sales order document number (DocID) |
get_pending_sales_orders_to_authorize
Get the count of sales orders that are pending authorization.
Sin parámetros.
get_sales_order
Get the full detail of a single sales order by its document number, including header (customer, currency, total) and line items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Sales order document number (DocID) |
search_sales_orders
List sales orders with optional filters by customer name and date range. Returns the 50 most recent matches with document id, date, customer, currency and total.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | No | Customer name (or part of it) to filter by. Leave empty for all customers. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
Sales Receipts 4
create_sales_receipt
Create a cash sale (sales receipt) for a customer (by name) for one item (by SKU or name) and quantity. The payment is posted to the default cash account; the document currency is that account's currency. Fiscal numbering, taxes and posting are handled by the system. Returns a link to the created receipt.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | Sí | Customer name (or part of it) |
itemSkuOrName | text | Sí | Item SKU or name |
quantity | number | Sí | Quantity to sell |
notes | text | No | Optional notes / observations to store on the document. |
delete_sales_receipt
Delete a cash sale (sales receipt) by its document number. Reverses posting/stock through the system and is blocked when it has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Sales receipt document number (DocID) |
get_sales_receipt
Get the full detail of a single cash sale (sales receipt) by its document number, including header (customer, currency, total) and line items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Sales receipt document number (DocID) |
search_sales_receipts
List cash sales (sales receipts) with optional filters by customer name and date range. Returns the 50 most recent matches with document id, date, customer, currency and total.
| Parámetro | Tipo | Requerido | Descripción |
|---|
customerName | text | No | Customer name (or part of it) to filter by. Leave empty for all customers. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
Services 5
create_service
Create a service. The name is required, and so is the SKU unless the company is configured to auto-number services. Services need no units of measure. Returns the new service id.
| Parámetro | Tipo | Requerido | Descripción |
|---|
sku | text | No | Service SKU / code. Leave empty only when the company is configured to auto-number services. |
name | text | Sí | Service name / description. Required. |
itemClassName | text | No | Item class name. Optional. |
salesDescription | text | No | Sales description shown on sales documents. Optional. |
purchaseDescription | text | No | Purchase description shown on purchase documents. Optional. |
salesItem | boolean | No | Whether the service can be sold. Optional, defaults to true. |
purchaseItem | boolean | No | Whether the service can be purchased. Optional, defaults to true. |
delete_service
Delete a service by its id. Blocked by the system when the service has linked records (transactions, kits, price lists). This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
serviceId | id (guid) | Sí | Id of the service to delete (Guid). Required. Get it from search_services. |
get_service
Get a service by its id (SKU, name, descriptions, item class, whether it can be sold or purchased).
| Parámetro | Tipo | Requerido | Descripción |
|---|
serviceId | id (guid) | Sí | Service id (Guid). Get it from search_services. |
search_services
Search services by SKU or name and return a summary list (top 20 matches). Pass an empty search to list the first 20 services.
| Parámetro | Tipo | Requerido | Descripción |
|---|
search | text | No | Text to search for in the service SKU or name. Empty returns the first 20 services. |
includeInactive | boolean | No | Include inactive services in the result. Optional, defaults to false. |
update_service
Update a service by its id. Only the fields you pass are changed; leave a field empty to keep its current value.
| Parámetro | Tipo | Requerido | Descripción |
|---|
serviceId | id (guid) | Sí | Id of the service to update (Guid). Required. Get it from search_services. |
sku | text | No | New SKU / code. Leave empty to keep the current value. |
name | text | No | New name / description. Leave empty to keep the current value. |
itemClassName | text | No | New item class name. Leave empty to keep the current value. |
salesDescription | text | No | New sales description. Leave empty to keep the current value. |
purchaseDescription | text | No | New purchase description. Leave empty to keep the current value. |
salesItem | boolean | No | Whether the service can be sold. Leave empty to keep the current value. |
purchaseItem | boolean | No | Whether the service can be purchased. Leave empty to keep the current value. |
inactive | boolean | No | Whether the service is inactive. Leave empty to keep the current value. |
Session 5
get_current_context
Show who you are signed in as and which company and user group (role) the tools are currently acting on. Call this first if you are unsure of the active company/role.
Sin parámetros.
list_companies
List the companies the signed-in user can access, so one can be picked with select_company. For each company it reports its plan (Basic, Standard, Enterprise, ...) and its type (Demo, Trial or Paid). Marks the company currently in use.
Sin parámetros.
list_user_groups
List the user groups (roles) available in the currently selected company, so one can be picked with select_user_group. Marks the group currently in use.
Sin parámetros.
select_company
Set the company the tools operate on, by its name or id. Switching company clears the current user group; when the new company has a single group it is selected automatically, otherwise call select_user_group next.
| Parámetro | Tipo | Requerido | Descripción |
|---|
company | text | Sí | Company name (or part of it) or id to switch to. |
selections | UserSelectionStore | Sí | |
select_user_group
Set the user group (role) the tools operate as, by its name or id, within the currently selected company. Select a company first with select_company.
| Parámetro | Tipo | Requerido | Descripción |
|---|
userGroup | text | Sí | User group name (or part of it) or id to switch to. |
selections | UserSelectionStore | Sí | |
Vendor Bills 4
create_bill
Create a vendor bill for a vendor (by name) for one item (by SKU or name), quantity and unit cost. Taxes, fiscal numbering and posting are handled by the system. Returns a link to the created bill.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorName | text | Sí | Vendor name (or part of it) |
itemSkuOrName | text | Sí | Item SKU or name |
quantity | number | Sí | Quantity to bill |
unitCost | number | Sí | Unit cost in the vendor's currency |
notes | text | No | Optional notes / observations to store on the document. |
delete_bill
Delete a vendor bill by its document number. Reverses posting/stock through the system and is blocked when the bill has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Vendor bill document number (DocID) |
get_bill
Get the full detail of a single vendor bill (including purchase with reception) by its document number, including header (vendor, currency, total, pending balance) and line items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Vendor bill document number (DocID), e.g. the value shown as the document id in search_bills. |
search_bills
List vendor bills (including purchases with reception) with optional filters by vendor name, date range and open-balance only. Returns the 50 most recent matches with document id, date, vendor, total and pending balance.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorName | text | No | Vendor name (or part of it) to filter by. Leave empty for all vendors. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
onlyOpen | boolean | Sí | When true, only bills with a pending balance are returned. |
Vendor Credits 4
create_vendor_credit
Create a vendor credit (vendor credit note) for a vendor (by name) for one item (by SKU or name), quantity and unit cost. A reference (the vendor's document number) is required. Taxes and posting are handled by the system. Returns a link to the created vendor credit.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorName | text | Sí | Vendor name (or part of it) |
itemSkuOrName | text | Sí | Item SKU or name |
quantity | number | Sí | Quantity to credit |
unitCost | number | Sí | Unit cost in the vendor's currency |
reference | text | Sí | Reference: the vendor's credit-note document number. Required. |
notes | text | No | Optional notes / observations to store on the document. |
delete_vendor_credit
Delete a vendor credit by its document number. Reverses posting through the system and is blocked when it has linked documents. This cannot be undone.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Vendor credit document number (DocID) |
get_vendor_credit
Get the full detail of a single vendor credit by its document number, including header (vendor, currency, total) and line items.
| Parámetro | Tipo | Requerido | Descripción |
|---|
docId | text | Sí | Vendor credit document number (DocID) |
search_vendor_credits
List vendor credits with optional filters by vendor name and date range. Returns the 50 most recent matches with document id, date, vendor, currency and total.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorName | text | No | Vendor name (or part of it) to filter by. Leave empty for all vendors. |
dateFrom | text | No | Start date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound. |
dateTo | text | No | End date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound. |
Vendors 7
create_vendor
Create a new vendor. Only the name is required; all other fields are optional. Returns the new vendor id.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Vendor (company) name. Required. |
code | text | No | Vendor code/identifier. Leave empty to auto-generate when the company is configured for it. |
comercialName | text | No | Commercial / trade name. Optional. |
email | text | No | Email address. Optional. |
phone1 | text | No | Phone number. Optional. |
fiscalID | text | No | Tax id (RNC/Cédula/Fiscal ID). Optional. |
currencyID | text | No | Currency id (e.g. DOP, USD). Optional; defaults to the company currency when empty. |
delete_vendor
Delete a vendor by its id. Fails when the vendor has linked records (transactions, etc.) or when the record is also a customer.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorId | id (guid) | Sí | Id of the vendor to delete. Required. |
get_aged_payables
Get the accounts-payable aging report summarized by vendor, in the company currency. Buckets are 30-day periods since the document date (0-30, 31-60, 61-90, over 90). Lists the top 50 vendors by balance.
Sin parámetros.
get_vendor_balance
Find a vendor by name and return their accounts-payable balance and overdue amount in the company currency.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Vendor name (or part of it) to look up |
get_vendor_info
Find a vendor by name and return their details (phone, e-mail, fiscal ID) together with their contacts. Returns matches when the name is ambiguous.
| Parámetro | Tipo | Requerido | Descripción |
|---|
name | text | Sí | Vendor name (or part of it) to look up |
search_vendors
Search vendors by name, code or fiscal ID and return a summary list (top 20 matches). Pass an empty search to list the first 20 vendors.
| Parámetro | Tipo | Requerido | Descripción |
|---|
search | text | No | Text to search for in the vendor name, code or fiscal ID. Empty returns the first 20 vendors. |
update_vendor
Update an existing vendor by its id. Only the fields you pass are changed; leave a field empty to keep its current value.
| Parámetro | Tipo | Requerido | Descripción |
|---|
vendorId | id (guid) | Sí | Id of the vendor to update. Required. |
name | text | No | New name. Leave empty to keep the current value. |
code | text | No | New code. Leave empty to keep the current value. |
comercialName | text | No | New commercial / trade name. Leave empty to keep the current value. |
email | text | No | New email. Leave empty to keep the current value. |
phone1 | text | No | New phone number. Leave empty to keep the current value. |
fiscalID | text | No | New tax id (RNC/Cédula/Fiscal ID). Leave empty to keep the current value. |
currencyID | text | No | New currency id (e.g. DOP, USD). Leave empty to keep the current value. |
No se encontraron herramientas que coincidan con la búsqueda.