AdmCloud MCP Server

Servidor en ejecución · Versión 1.18 · Endpoint MCP: /mcp

Este servidor expone 161 herramientas en 36 categorías. Esta página es una referencia para clientes y personal de soporte.

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ámetroTipoRequeridoDescripción
nametextSíAccount name. Required.
codetextNoAccount code. Optional (may be auto-generated).
accountClasstextSíAccount class name (AccountClassEnum value, e.g. Cash, Bank, Income, Expense). Required.
currencyIDtextNoCurrency 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ámetroTipoRequeridoDescripción
idid (guid)SíAccount id (Guid).

get_account

Get a chart-of-accounts (GL) account by its id.

ParámetroTipoRequeridoDescripción
idid (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ámetroTipoRequeridoDescripción
accountNametextSí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ámetroTipoRequeridoDescripción
accountNametextSíAccount code or name to search for
yearintegerSíThe year
monthintegerSí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ámetroTipoRequeridoDescripción
yearintegerSíThe year

get_expenses_by_month_for_account

Get monthly expenses for a single account, found by code or name, for a year.

ParámetroTipoRequeridoDescripción
yearintegerSíThe year
accountNametextSí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ámetroTipoRequeridoDescripción
yearintegerSíThe year

search_accounts

List chart-of-accounts (GL) accounts by code or name (empty for all). Returns pages of 50 non-group accounts by code, with id, code, name, class and currency. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoCode or name filter (or part of it). Leave empty for all.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
dateTotextNoCut-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ámetroTipoRequeridoDescripción
yearintegerSíThe year
monthintegerSíThe month (1-12). Only with an account it can be 0 for the whole year.
accountNametextNoAccount 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ámetroTipoRequeridoDescripción
yearintegerSíThe year
monthintegerSí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ámetroTipoRequeridoDescripción
yearintegerSí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ámetroTipoRequeridoDescripción
yearintegerSíThe year
monthintegerSíThe month (1-12), or 0 for the whole fiscal year

Bank Transfers 4

create_transfer

Create a transfer between two bank/cash accounts (given by name or code) for an amount. Assumes both accounts share the same currency. Returns a link to the created transfer.

ParámetroTipoRequeridoDescripción
fromAccounttextSíSource account name or code (money leaves this account)
toAccounttextSíDestination account name or code (money enters this account)
amountnumberSíAmount to transfer, in the accounts' currency
notestextNoOptional notes / observations to store on the document.

delete_transfer

Delete a bank transfer by its document number. Reverses posting through the system and is blocked when it has linked documents. This cannot be undone.

ParámetroTipoRequeridoDescripción
docIdtextSíTransfer document number (DocID)

get_transfer

Get the detail of a single bank transfer by its document number.

ParámetroTipoRequeridoDescripción
docIdtextSíTransfer document number (DocID)

search_transfers

List bank transfers with an optional date range. Returns pages of 50 matches, most recent first, with document id, date, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Bill Payments 4

create_bill_payment

Record a payment to a vendor as an advance (NOT applied to specific bills) for a given amount. The money leaves the given cash/bank account (by name or code), or the default cash account when omitted. The document currency is that account's currency.

ParámetroTipoRequeridoDescripción
vendorNametextSíVendor name (or part of it)
amountnumberSíAmount paid, in the cash account's currency
cashAccounttextNoCash/bank account name or code the money leaves from. Leave empty to use the single default cash account.
notestextNoOptional notes / observations to store on the document.

delete_bill_payment

Delete a vendor payment (advance) by its document number. Reverses posting through the system and is blocked when it has linked documents. This cannot be undone.

ParámetroTipoRequeridoDescripción
docIdtextSíVendor payment document number (DocID)

get_bill_payment

Get the detail of a single vendor payment (advance) by its document number.

ParámetroTipoRequeridoDescripción
docIdtextSíVendor payment document number (DocID)

search_bill_payments

List vendor payments (advances) with optional filters by vendor name and date range. Returns pages of 50 matches, most recent first, with document id, date, vendor, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
vendorNametextNoVendor name (or part of it) to filter by. Leave empty for all vendors.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Cash 3

get_available_cash_by_bank

Get the available balance of each bank account. Optionally filter by account name (leave empty for all).

ParámetroTipoRequeridoDescripción
accountNametextSíBank account name to filter by, or empty for all accounts

get_available_cash_in_bank

Get the total available cash across all bank accounts, expressed in the company currency.

Sin parámetros.

get_current_loans

Get the current outstanding balance of each loan, expressed in the company currency.

Sin parámetros.

Collections 1

get_monthly_collections

Get total collections (cash received from customers) broken down by month for a year.

ParámetroTipoRequeridoDescripción
yearintegerSíThe year

Company Info 2

get_company_name

Get the name of the company (or subsidiary) the user is signed in to.

Sin parámetros.

get_default_currency

Get the default (functional) currency of the company or subsidiary the user is signed in to.

Sin parámetros.

Contacts 6

create_contact

Create a new contact. At least a first name, last name or e-mail is required; all other fields are optional. Pass relationshipID to link the contact to a customer or vendor. Returns the new contact id.

ParámetroTipoRequeridoDescripción
firstNametextNoFirst name. Optional, but at least first name, last name or e-mail is required.
lastNametextNoLast name. Optional, but at least first name, last name or e-mail is required.
emailtextNoE-mail address. Optional, but at least first name, last name or e-mail is required.
phone1textNoPhone number. Optional.
positiontextNoPosition / job title. Optional.
relationshipIDid (guid)NoId of the related customer/vendor (SA_Relationships) to link this contact to. Optional.

delete_contact

Delete a contact by its id. Fails when the contact has linked records (transactions, opportunities, trips, activities, fixed assets). This cannot be undone.

ParámetroTipoRequeridoDescripción
idid (guid)SíContact id (Guid).

get_contact

Get a contact by its id (name, phone, e-mail, position, department, birthday).

ParámetroTipoRequeridoDescripción
idid (guid)SíContact id (Guid).

get_contact_info

Find a contact by full name and return their details (phone, e-mail, position, department, birthday). Returns matches when the name is ambiguous.

ParámetroTipoRequeridoDescripción
nametextSíFull name (or part of it) of the contact to look up

search_contacts

Search contacts by name, e-mail, phone or position and return a summary list in pages of 20. Pass an empty search to list all contacts. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the contact name, e-mail, phone or position. Empty returns the first 20 contacts.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

update_contact

Update an existing contact by its id. Only the fields you pass are changed; leave a field empty to keep its current value. The contact must keep at least a first name, last name or e-mail.

ParámetroTipoRequeridoDescripción
contactIdid (guid)SíId of the contact to update (Guid). Required. Get it from search_contacts.
firstNametextNoNew first name. Leave empty to keep the current value.
lastNametextNoNew last name. Leave empty to keep the current value.
emailtextNoNew e-mail address. Leave empty to keep the current value.
phone1textNoNew phone number. Leave empty to keep the current value.
positiontextNoNew position / job title. Leave empty to keep the current value.
relationshipIDid (guid)NoId of the related customer/vendor (SA_Relationships) to link this contact to. Leave empty to keep the current link.

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. It can be linked to a project (projectName). Returns a link to the created credit memo.

ParámetroTipoRequeridoDescripción
customerNametextSíCustomer name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to credit
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSí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, project, currency, total) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSíCredit memo document number (DocID)

search_credit_memos

List customer credit memos with optional filters by customer name, project and date range. Returns pages of 50 matches, most recent first, with document id, date, customer, project, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
customerNametextNoCustomer name (or part of it) to filter by. Leave empty for all customers.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Customers 7

create_customer

Create a new customer. Only the name is required; all other fields are optional. Returns the new customer id.

ParámetroTipoRequeridoDescripción
nametextSíCustomer (company) name. Required.
codetextNoCustomer code/identifier. Leave empty to auto-generate when the company is configured for it.
comercialNametextNoCommercial / trade name. Optional.
emailtextNoEmail address. Optional.
phone1textNoPhone number. Optional.
fiscalIDtextNoTax id (RNC/Cédula/Fiscal ID). Optional.
currencyIDtextNoCurrency id (e.g. DOP, USD). Optional; defaults to the company currency when empty.
priceLevelNametextNoPrice 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ámetroTipoRequeridoDescripción
customerIdid (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 customers in pages of 50, highest balance first; the totals always cover every customer. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

get_customer_balance

Find a customer by name and return their accounts-receivable balance and overdue amount in the company currency.

ParámetroTipoRequeridoDescripción
nametextSí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ámetroTipoRequeridoDescripción
nametextSíCustomer name (or part of it) to look up

search_customers

Search customers by name, code or fiscal ID and return a summary list in pages of 20. Pass an empty search to list all customers. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the customer name, code or fiscal ID. Empty returns the first 20 customers.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
customerIdid (guid)SíId of the customer to update. Required.
nametextNoNew name. Leave empty to keep the current value.
codetextNoNew code. Leave empty to keep the current value.
comercialNametextNoNew commercial / trade name. Leave empty to keep the current value.
emailtextNoNew email. Leave empty to keep the current value.
phone1textNoNew phone number. Leave empty to keep the current value.
fiscalIDtextNoNew tax id (RNC/Cédula/Fiscal ID). Leave empty to keep the current value.
currencyIDtextNoNew currency id (e.g. DOP, USD). Leave empty to keep the current value.

Departments 4

create_department

Create a department. Only the name is required; pass a parent department name to nest it. Returns the new id.

ParámetroTipoRequeridoDescripción
nametextSíDepartment name. Required.
parentNametextNoParent department name (or part of it). Optional.

delete_department

Delete a department by its id. Blocked by the system when it is in use. This cannot be undone.

ParámetroTipoRequeridoDescripción
idid (guid)SíDepartment id (Guid).

get_department

Get a department by its id.

ParámetroTipoRequeridoDescripción
idid (guid)SíDepartment id (Guid).

search_departments

List departments filtered by name (empty for all). Returns pages of 50 by name, with id and name. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoName filter (or part of it). Leave empty for all.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Deposits 4

create_deposit

Create a bank deposit: money enters the destination bank account with an offsetting source account as the counterpart. Both accounts are given by name or code. It can be linked to a project (projectName). Returns a link to the created deposit.

ParámetroTipoRequeridoDescripción
bankAccounttextSíDestination bank account name or code (where the money is deposited)
sourceAccounttextSíSource/counterpart account name or code (credited)
amountnumberSíAmount to deposit, in the bank account's currency
projectNametextNoProject name or code for the source account line (the deposit's revenue/counterpart). Optional; leave empty for no project.
notestextNoOptional notes / observations to store on the document.

delete_deposit

Delete a bank deposit by its document number. Reverses posting through the system and is blocked when it has linked documents. This cannot be undone.

ParámetroTipoRequeridoDescripción
docIdtextSíDeposit document number (DocID)

get_deposit

Get the detail of a single bank deposit by its document number.

ParámetroTipoRequeridoDescripción
docIdtextSíDeposit document number (DocID)

search_deposits

List bank deposits with optional filters by project and date range. Returns pages of 50 matches, most recent first, with document id, date, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Employees 5

create_employee

Create an employee (a non-user employee, without a login). First and last name are required. Returns the new employee id.

ParámetroTipoRequeridoDescripción
firstNametextSíFirst name. Required.
lastNametextSíLast name. Required.
emailtextNoEmail. Optional.
phone1textNoPhone number. Optional.

delete_employee

Delete an employee by its id. Blocked by the system when the employee is in use. This cannot be undone.

ParámetroTipoRequeridoDescripción
employeeIdid (guid)SíEmployee id (Guid). Get it from get_employees.

get_employees

Get the list of active employees with their contact details, position and department.

Sin parámetros.

update_employee

Update an employee's basic data by its id. Only the fields you pass are changed; leave a field empty to keep its current value. User-group membership and system access are never modified by this tool.

ParámetroTipoRequeridoDescripción
employeeIdid (guid)SíId of the employee to update (Guid). Required. Get it from get_employees.
firstNametextNoNew first name. Leave empty to keep the current value.
lastNametextNoNew last name. Leave empty to keep the current value.
emailtextNoNew email. Leave empty to keep the current value.
phone1textNoNew phone number. Leave empty to keep the current value.

who_is_out_today

Get the employees who are out of office today (approved time off), with their return date.

Sin parámetros.

Identity 1

who_am_i

Returns the username of the currently authenticated user.

Sin parámetros.

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ámetroTipoRequeridoDescripción
skutextNoItem SKU / code. Leave empty only when the company is configured to auto-number items.
nametextSíItem name / description. Required.
itemClassNametextNoItem class name. Optional.
uomPlanNametextNoUnit-of-measure conversion plan name. Optional: required only when the company has more than one plan.
uomNametextNoUnit of measure name, used as the report, purchase and sales unit. Optional: required only when the conversion plan has more than one unit.
salesDescriptiontextNoSales description shown on sales documents. Optional.
purchaseDescriptiontextNoPurchase description shown on purchase documents. Optional.
salesItembooleanNoWhether the item can be sold. Optional, defaults to true.
purchaseItembooleanNoWhether the item can be purchased. Optional, defaults to true.
stockItembooleanNoWhether 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ámetroTipoRequeridoDescripción
itemIdid (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ámetroTipoRequeridoDescripción
skuOrNametextSí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ámetroTipoRequeridoDescripción
filterBySubsidiarybooleanSí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ámetroTipoRequeridoDescripción
itemNametextSíItem SKU or name to search for
locationNametextSíLocation name to search for

search_items

Search inventory items and services by SKU or name and return a summary list in pages of 20. Pass an empty search to list all items. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the item SKU or name. Empty returns the first 20 items.
includeInactivebooleanSíWhen true, inactive items are included in the results.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
itemIdid (guid)SíId of the item to update (Guid). Required. Get it from search_items.
skutextNoNew SKU / code. Leave empty to keep the current value.
nametextNoNew name / description. Leave empty to keep the current value.
itemClassNametextNoNew item class name. Leave empty to keep the current value.
uomNametextNoNew 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.
salesDescriptiontextNoNew sales description. Leave empty to keep the current value.
purchaseDescriptiontextNoNew purchase description. Leave empty to keep the current value.
salesItembooleanNoWhether the item can be sold. Leave empty to keep the current value.
purchaseItembooleanNoWhether the item can be purchased. Leave empty to keep the current value.
stockItembooleanNoWhether the item is included in stock control. Leave empty to keep the current value.
inactivebooleanNoWhether 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. It can be linked to a project (projectName). Returns a link to the created invoice.

ParámetroTipoRequeridoDescripción
customerNametextSíCustomer name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to invoice
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSíInvoice document number (DocID)

get_invoice

Get the full detail of a single credit sales invoice by its document number, including header (customer, project, currency, total, pending balance) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSí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, project, date range and open-balance only. Cash sales are in search_sales_receipts. Returns pages of 50 matches, most recent first, with document id, date, customer, project, total and pending balance. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
customerNametextNoCustomer name (or part of it) to filter by. Leave empty for all customers.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
onlyOpenbooleanSíWhen true, only invoices with a pending balance are returned.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Item Classes 4

create_item_class

Create an item class. Only the name is required; pass a parent class name to nest it. Returns the new id.

ParámetroTipoRequeridoDescripción
nametextSíItem class name. Required.
parentNametextNoParent item class name (or part of it). Optional.

delete_item_class

Delete an item class by its id. Blocked by the system when it is in use. This cannot be undone.

ParámetroTipoRequeridoDescripción
idid (guid)SíItem class id (Guid).

get_item_class

Get an item class by its id.

ParámetroTipoRequeridoDescripción
idid (guid)SíItem class id (Guid).

search_item_classes

List item classes filtered by name (empty for all). Returns pages of 50 by name, with id and name. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoName filter (or part of it). Leave empty for all.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Journals 1

search_journals

List manual journal entries with optional filters by project (on any line) and date range. Returns pages of 50 matches, most recent first, with document id, date, currency and total (total debit = total credit). When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
skutextNoKit SKU / code. Leave empty only when the company is configured to auto-number kits.
nametextSíKit name / description. Required.
componentslist of ComponentInputSíItems and services that make up the kit. At least one is required.
itemClassNametextNoItem class name. Optional.
salesDescriptiontextNoSales description shown on sales documents. Optional.
showComponentsbooleanNoShow the kit components on transactions. Optional, defaults to false.
allowComponentsQuantityChangebooleanNoAllow changing component quantities on transactions. Optional, defaults to false. Turning this on also shows the components.
pricesOnKitComponentsbooleanNoHandle 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ámetroTipoRequeridoDescripción
kitIdid (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ámetroTipoRequeridoDescripción
kitIdid (guid)SíKit id (Guid). Get it from search_kits.

search_kits

Search kits by SKU or name and return a summary list in pages of 20. Pass an empty search to list all kits. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the kit SKU or name. Empty returns the first 20 kits.
includeInactivebooleanNoInclude inactive kits in the result. Optional, defaults to false.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
kitIdid (guid)SíId of the kit to update (Guid). Required. Get it from search_kits.
skutextNoNew SKU / code. Leave empty to keep the current value.
nametextNoNew name / description. Leave empty to keep the current value.
componentslist of ComponentInputNoFull 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.
itemClassNametextNoNew item class name. Leave empty to keep the current value.
salesDescriptiontextNoNew sales description. Leave empty to keep the current value.
showComponentsbooleanNoShow the kit components on transactions. Leave empty to keep the current value.
allowComponentsQuantityChangebooleanNoAllow changing component quantities on transactions. Leave empty to keep the current value.
pricesOnKitComponentsbooleanNoHandle prices at component level. Leave empty to keep the current value. Requires showComponents to be true.
inactivebooleanNoWhether 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ámetroTipoRequeridoDescripción
nametextSíName of the opportunity
phonetextSíPhone number for the lead
contacttextSí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ámetroTipoRequeridoDescripción
idid (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ámetroTipoRequeridoDescripción
idid (guid)SíOpportunity id (Guid).

search_opportunities

Search sales opportunities by name, contact, phone, e-mail or customer name and return a summary list in pages of 20. Pass an empty search to list the most recent opportunities. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the opportunity name, contact, phone, e-mail or customer name. Empty returns the most recent opportunities.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
customerNametextSíCustomer name (or part of it)
amountnumberSíAmount received, in the cash account's currency
cashAccounttextNoCash/bank account name or code to receive the money. Leave empty to use the single default cash account.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSí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ámetroTipoRequeridoDescripción
docIdtextSí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 pages of 50 matches, most recent first, with document id, date, customer, reference and amount. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
customerNametextNoCustomer name (or part of it) to filter by. Leave empty for all customers.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Payment Terms 4

create_payment_term

Create a payment term. Only the name is required. Returns the new id.

ParámetroTipoRequeridoDescripción
nametextSíPayment term name. Required.

delete_payment_term

Delete a payment term by its id. Blocked by the system when it is in use. This cannot be undone.

ParámetroTipoRequeridoDescripción
idid (guid)SíPayment term id (Guid).

get_payment_term

Get a payment term by its id.

ParámetroTipoRequeridoDescripción
idid (guid)SíPayment term id (Guid).

search_payment_terms

List payment terms filtered by name (empty for all). Returns pages of 50 by name, with id and name. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoName filter (or part of it). Leave empty for all.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Projects 6

create_project

Create a project. The name is required, and so is the code unless the company is configured to auto-number projects. Customer, manager, project class and parent project are given by name. Status defaults to Open. Returns the new project id.

ParámetroTipoRequeridoDescripción
codetextNoProject code. Leave empty only when the company is configured to auto-number projects.
nametextSíProject name / description. Required.
subsidiaryNametextNoSubsidiary name. Optional: defaults to the session's subsidiary; needed only when the company has several subsidiaries and the user group is not tied to one.
customerNametextNoCustomer name (or part of it). Optional.
managerNametextNoName of the employee who manages the project. Optional.
projectClassNametextNoProject class name. Optional.
parentProjectNametextNoParent project name or code, to make this a sub-project. Optional.
statustextNoStatus: Estimate, Open, Pause, Completed, Closed or Canceled. Optional, defaults to Open.
beginDatetextNoBegin date in yyyy-MM-dd format. Optional.
endDatetextNoEnd date in yyyy-MM-dd format. Optional.
currencyIdtextNoCurrency code of the project (e.g. DOP, USD). Optional.
potextNoCustomer purchase order number. Optional.
notestextNoNotes. Optional.

delete_project

Delete a project by its id. Blocked by the system when the project has sub-projects, budgets or transactions. This cannot be undone.

ParámetroTipoRequeridoDescripción
projectIdid (guid)SíId of the project to delete (Guid). Required. Get it from search_projects.

get_project

Get a project by its id: code, name, status, customer, manager, project class, parent project, subsidiary, cost centers, currency, dates, PO and notes.

ParámetroTipoRequeridoDescripción
projectIdid (guid)SíProject id (Guid). Get it from search_projects.

get_project_summary

Project summary report: for each project, budget (revenue, expenses, materials) versus actuals (revenue, expenses, dispatched materials cost, purchase orders pending billing, work in progress), result and profitability, up to a cut-off date, plus totals. Amounts in local currency. Same data as the 'Project summary' report.

ParámetroTipoRequeridoDescripción
projectNametextNoProject name or code to limit the report to one project. Leave empty for all projects.
customerNametextNoCustomer name (or part of it) to limit the report to that customer's projects. Leave empty for all customers.
parentProjectNametextNoParent project name or code to limit the report to its sub-projects. Leave empty for no filter.
dateTotextNoCut-off date (inclusive) in yyyy-MM-dd format. Leave empty for no cut-off (everything to date).

search_projects

Search projects by name, code, manager, project class or customer (empty for all), optionally only for one customer or only open ones. Returns pages of 50 by name, with id, code, name, status, customer, manager and dates. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the project name, code, manager, class or customer. Leave empty for all projects.
customerNametextNoCustomer name (or part of it) to filter by. Leave empty for all customers.
onlyOpenbooleanNoWhen true, only open projects are returned. Optional, defaults to false.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

update_project

Update a project by its id. Only the fields you pass are changed; leave a field empty to keep its current value. Budget, tasks, files and other details are kept as they are.

ParámetroTipoRequeridoDescripción
projectIdid (guid)SíId of the project to update (Guid). Required. Get it from search_projects.
codetextNoNew code. Leave empty to keep the current value.
nametextNoNew name / description. Leave empty to keep the current value.
customerNametextNoNew customer name (or part of it). Leave empty to keep the current value.
managerNametextNoNew manager (employee) name. Leave empty to keep the current value.
projectClassNametextNoNew project class name. Leave empty to keep the current value.
parentProjectNametextNoNew parent project name or code. Leave empty to keep the current value.
statustextNoNew status: Estimate, Open, Pause, Completed, Closed or Canceled. Leave empty to keep the current value.
beginDatetextNoNew begin date in yyyy-MM-dd format. Leave empty to keep the current value.
endDatetextNoNew end date in yyyy-MM-dd format. Leave empty to keep the current value.
currencyIdtextNoNew currency code. Leave empty to keep the current value.
potextNoNew customer purchase order number. Leave empty to keep the current value.
notestextNoNew notes. Leave empty to keep the current value.

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. It can be linked to a project (projectName). Returns a link to the created order.

ParámetroTipoRequeridoDescripción
vendorNametextSíVendor name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to order
unitCostnumberSíUnit cost in the vendor's currency
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSí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, project, currency, total) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSíPurchase order document number (DocID)

search_purchase_orders

List purchase orders with optional filters by vendor name, project and date range. Returns pages of 50 matches, most recent first, with document id, date, vendor, project, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
vendorNametextNoVendor name (or part of it) to filter by. Leave empty for all vendors.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Quotes 4

create_quote

Create a sales quote for a customer (by name) for one item (by SKU or name) and quantity. The item must have a price in the customer's currency. It can be linked to a project (projectName). Returns a link to the created quote.

ParámetroTipoRequeridoDescripción
customerNametextSíCustomer name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to quote
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional notes / observations to store on the document.

delete_quote

Delete a sales quote by its document number. Blocked by the system when the quote has linked documents. This cannot be undone.

ParámetroTipoRequeridoDescripción
docIdtextSíQuote document number (DocID)

get_quote

Get the full detail of a single sales quote by its document number, including header (customer, project, currency, total) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSíQuote document number (DocID)

search_quotes

List sales quotes with optional filters by customer name, project and date range. Returns pages of 50 matches, most recent first, with document id, date, customer, project, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
customerNametextNoCustomer name (or part of it) to filter by. Leave empty for all customers.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Sales 7

get_monthly_sales

Get total sales broken down by month for a year.

ParámetroTipoRequeridoDescripción
yearintegerSíThe year

get_sales

Get sales for a specific year

ParámetroTipoRequeridoDescripción
yearintegerSíThe year

get_sales_by_item_class

Get total sales of a year grouped by item class (product line).

ParámetroTipoRequeridoDescripción
yearintegerSíThe year

get_sales_by_sales_rep

Get total sales of a year grouped by sales representative.

ParámetroTipoRequeridoDescripción
yearintegerSíThe year

get_sales_for_customer

Get the sales of a year for a specific customer, found by name.

ParámetroTipoRequeridoDescripción
yearintegerSíThe year
customerNametextSíCustomer name (or part of it) to search for

get_top10_sales_by_customer

Get the 10 customers with the highest sales for a year.

ParámetroTipoRequeridoDescripción
yearintegerSíThe year

get_top10_sales_by_item

Get the 10 items with the highest sales (amount and quantity) for a year.

ParámetroTipoRequeridoDescripción
yearintegerSíThe year

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. It can be linked to a project (projectName). Returns a link to the created order.

ParámetroTipoRequeridoDescripción
customerNametextSíCustomer name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to order
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSí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, project, currency, total) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSíSales order document number (DocID)

search_sales_orders

List sales orders with optional filters by customer name, project and date range. Returns pages of 50 matches, most recent first, with document id, date, customer, project, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
customerNametextNoCustomer name (or part of it) to filter by. Leave empty for all customers.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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. It can be linked to a project (projectName). Returns a link to the created receipt.

ParámetroTipoRequeridoDescripción
customerNametextSíCustomer name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to sell
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSí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, project, currency, total) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSíSales receipt document number (DocID)

search_sales_receipts

List cash sales (sales receipts) with optional filters by customer name, project and date range. Returns pages of 50 matches, most recent first, with document id, date, customer, project, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
customerNametextNoCustomer name (or part of it) to filter by. Leave empty for all customers.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Service Requests 6

change_service_request_status

Move a service request to another status, given the status name. The status must belong to the workflow of the request, and the user must be allowed to use it; both rules are enforced by AdmCloud.

ParámetroTipoRequeridoDescripción
serviceRequestIdid (guid)SíService request id (Guid). Get it from search_service_requests.
statusNametextSíName of the destination status, as configured by the company (for example 'En Proceso' or 'Entregada').

create_service_request

Create a service request. The description and the customer are required; every other field is optional and is matched by name. The number and the initial status are assigned by AdmCloud. Returns the new service request id and a link to it.

ParámetroTipoRequeridoDescripción
descriptiontextSíWhat the customer is asking for. Required.
customerNametextSíCustomer name. Required; it must match exactly one customer.
transTypeNametextNoTransaction type name of the service request (SA_Trans_Types configured for service requests). Optional.
subsidiaryNametextNoSubsidiary name. Optional; defaults to the subsidiary of the session, and it cannot be a different one when the user group is tied to a subsidiary.
requestedByContactNametextNoName of the customer contact that requested the service ('requested by'). Optional; only contacts of that customer are considered.
priorityNametextNoPriority name, as configured by the company. Optional.
internalPriorityNametextNoInternal priority name, as configured by the company. Optional.
groupNametextNoTransaction group name the request belongs to. Optional.
warrantybooleanNoTrue when the work is covered by warranty (no charge), false when it is billable. Optional, defaults to billable.

delete_service_request

Delete a service request by its id. Fails when it has linked records (work orders, invoices). This cannot be undone.

ParámetroTipoRequeridoDescripción
serviceRequestIdid (guid)SíService request id (Guid). Get it from search_service_requests.

get_service_request

Get a service request by its id (number, date, description, customer, status, transaction type, requested by, priorities, group and whether it is under warranty).

ParámetroTipoRequeridoDescripción
serviceRequestIdid (guid)SíService request id (Guid). Get it from search_service_requests.

search_service_requests

Search service requests by document number, description or customer name and return a summary list in pages of 20. Pass an empty search to list the most recent ones. Only open requests are listed unless includeClosed is true. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the service request number, description or customer name. Empty returns the most recent service requests.
includeClosedbooleanNoInclude service requests already in a closing status. Optional, defaults to false.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

update_service_request

Update a service request by its id. Only the fields you pass are changed; leave a field empty to keep its current value. The customer cannot be changed, and the status is changed with change_service_request_status.

ParámetroTipoRequeridoDescripción
serviceRequestIdid (guid)SíService request id (Guid). Get it from search_service_requests.
descriptiontextNoNew description of what the customer is asking for. Optional.
transTypeNametextNoTransaction type name of the service request. Optional.
requestedByContactNametextNoName of the customer contact that requested the service ('requested by'). Optional; only contacts of that customer are considered.
priorityNametextNoPriority name, as configured by the company. Optional.
internalPriorityNametextNoInternal priority name, as configured by the company. Optional.
groupNametextNoTransaction group name the request belongs to. Optional.
warrantybooleanNoTrue when the work is covered by warranty (no charge), false when it is billable. Optional.

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ámetroTipoRequeridoDescripción
skutextNoService SKU / code. Leave empty only when the company is configured to auto-number services.
nametextSíService name / description. Required.
itemClassNametextNoItem class name. Optional.
salesDescriptiontextNoSales description shown on sales documents. Optional.
purchaseDescriptiontextNoPurchase description shown on purchase documents. Optional.
salesItembooleanNoWhether the service can be sold. Optional, defaults to true.
purchaseItembooleanNoWhether 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ámetroTipoRequeridoDescripción
serviceIdid (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ámetroTipoRequeridoDescripción
serviceIdid (guid)SíService id (Guid). Get it from search_services.

search_services

Search services by SKU or name and return a summary list in pages of 20. Pass an empty search to list all services. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the service SKU or name. Empty returns the first 20 services.
includeInactivebooleanNoInclude inactive services in the result. Optional, defaults to false.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
serviceIdid (guid)SíId of the service to update (Guid). Required. Get it from search_services.
skutextNoNew SKU / code. Leave empty to keep the current value.
nametextNoNew name / description. Leave empty to keep the current value.
itemClassNametextNoNew item class name. Leave empty to keep the current value.
salesDescriptiontextNoNew sales description. Leave empty to keep the current value.
purchaseDescriptiontextNoNew purchase description. Leave empty to keep the current value.
salesItembooleanNoWhether the service can be sold. Leave empty to keep the current value.
purchaseItembooleanNoWhether the service can be purchased. Leave empty to keep the current value.
inactivebooleanNoWhether 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ámetroTipoRequeridoDescripción
companytextSíCompany name (or part of it) or id to switch to.
selectionsUserSelectionStoreSí

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ámetroTipoRequeridoDescripción
userGrouptextSíUser group name (or part of it) or id to switch to.
selectionsUserSelectionStoreSí

Tax Codes 2

get_tax_code

Get a tax code (schedule) by its id, including the taxes it groups.

ParámetroTipoRequeridoDescripción
idid (guid)SíTax code id (Guid).

search_tax_codes

List tax codes filtered by name (empty for all). Returns pages of 50 by name, with id and name. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoName filter (or part of it). Leave empty for all.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Time Off 3

delete_time_off

Delete (cancel) one of your own time off requests by its id — the id register_time_off returned. Only your own requests can be deleted, and the system blocks the deletion when the request already has linked records. This cannot be undone.

ParámetroTipoRequeridoDescripción
timeOffIdid (guid)SíTime off request id (Guid), as returned by register_time_off.

get_my_vacation_days

Get how many vacation days the authenticated user has left, detailed for each labor-contract period where they still have open (pending) days. Vacation days are calculated only for the Dominican Republic.

Sin parámetros.

register_time_off

Register a new time off request for the authenticated user. Provide the time off reason by name (e.g. 'Vacaciones', 'Enfermedad'), the start and end dates, and optional notes. For vacation reasons a labor-contract period is required — get it from get_my_vacation_days (the PeriodID field).

ParámetroTipoRequeridoDescripción
reasonNametextSíTime off reason name (e.g. 'Vacaciones', 'Enfermedad'). Matched against the company's configured reasons.
startDatedateSíStart date of the time off (inclusive).
endDatedateSíEnd date of the time off (inclusive).
notestextNoOptional notes / justification for the request.
laborContractPeriodintegerNoLabor-contract period id (PeriodID from get_my_vacation_days). Required only for vacation reasons; leave empty otherwise.

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. A reference (the vendor's document number) is required. Taxes, fiscal numbering and posting are handled by the system. It can be linked to a project (projectName). Returns a link to the created bill.

ParámetroTipoRequeridoDescripción
vendorNametextSíVendor name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to bill
unitCostnumberSíUnit cost in the vendor's currency
referencetextSíReference: the vendor's bill document number. Required.
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSí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, project, currency, total, pending balance) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSí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, project, date range and open-balance only. Returns pages of 50 matches, most recent first, with document id, date, vendor, project, total and pending balance. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
vendorNametextNoVendor name (or part of it) to filter by. Leave empty for all vendors.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
onlyOpenbooleanSíWhen true, only bills with a pending balance are returned.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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. It can be linked to a project (projectName). Returns a link to the created vendor credit.

ParámetroTipoRequeridoDescripción
vendorNametextSíVendor name (or part of it)
itemSkuOrNametextSíItem SKU or name
quantitynumberSíQuantity to credit
unitCostnumberSíUnit cost in the vendor's currency
referencetextSíReference: the vendor's credit-note document number. Required.
projectNametextNoProject name or code to link the document to. Optional; leave empty for no project.
notestextNoOptional 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ámetroTipoRequeridoDescripción
docIdtextSíVendor credit document number (DocID)

get_vendor_credit

Get the full detail of a single vendor credit by its document number, including header (vendor, project, currency, total) and line items.

ParámetroTipoRequeridoDescripción
docIdtextSíVendor credit document number (DocID)

search_vendor_credits

List vendor credits with optional filters by vendor name, project and date range. Returns pages of 50 matches, most recent first, with document id, date, vendor, project, currency and total. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
vendorNametextNoVendor name (or part of it) to filter by. Leave empty for all vendors.
projectNametextNoProject name or code to filter by: documents linked to the project on the header or on any line. Leave empty for all projects.
dateFromtextNoStart date (inclusive) in yyyy-MM-dd format. Leave empty for no lower bound.
dateTotextNoEnd date (inclusive) in yyyy-MM-dd format. Leave empty for no upper bound.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

Vendors 7

create_vendor

Create a new vendor. Only the name is required; all other fields are optional. Returns the new vendor id.

ParámetroTipoRequeridoDescripción
nametextSíVendor (company) name. Required.
codetextNoVendor code/identifier. Leave empty to auto-generate when the company is configured for it.
comercialNametextNoCommercial / trade name. Optional.
emailtextNoEmail address. Optional.
phone1textNoPhone number. Optional.
fiscalIDtextNoTax id (RNC/Cédula/Fiscal ID). Optional.
currencyIDtextNoCurrency 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ámetroTipoRequeridoDescripción
vendorIdid (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 vendors in pages of 50, highest balance first; the totals always cover every vendor. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

get_vendor_balance

Find a vendor by name and return their accounts-payable balance and overdue amount in the company currency.

ParámetroTipoRequeridoDescripción
nametextSí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ámetroTipoRequeridoDescripción
nametextSíVendor name (or part of it) to look up

search_vendors

Search vendors by name, code or fiscal ID and return a summary list in pages of 20. Pass an empty search to list all vendors. When hasMore is true, call again with skip = nextSkip for the next page.

ParámetroTipoRequeridoDescripción
searchtextNoText to search for in the vendor name, code or fiscal ID. Empty returns the first 20 vendors.
skipintegerNoNumber of matches to skip, for paging. Leave empty (or 0) for the first page; when the result has hasMore = true, pass its nextSkip to get the next page.

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ámetroTipoRequeridoDescripción
vendorIdid (guid)SíId of the vendor to update. Required.
nametextNoNew name. Leave empty to keep the current value.
codetextNoNew code. Leave empty to keep the current value.
comercialNametextNoNew commercial / trade name. Leave empty to keep the current value.
emailtextNoNew email. Leave empty to keep the current value.
phone1textNoNew phone number. Leave empty to keep the current value.
fiscalIDtextNoNew tax id (RNC/Cédula/Fiscal ID). Leave empty to keep the current value.
currencyIDtextNoNew currency id (e.g. DOP, USD). Leave empty to keep the current value.