kiotviet_list_products
List products
List products (code, barcode, name, category, base price, units, attributes). Optionally include stock per branch (include_inventory) and price-book prices. Filter by name, category, branch, active flag or last change. GET /products.
Parametersnameorder_byis_activepage_sizebranch_idscategory_idcurrent_itemorder_directioninclude_inventoryinclude_pricebooklast_modified_from
kiotviet_get_product
Get product
One product by id: code, barcode, name, category, base price, units, attributes, images, stock per branch and price books. GET /products/{id}.
Parametersproduct_idrequired
kiotviet_get_product_by_code
Get product by code
One product by its product code (SKU). GET /products/code/{code}.
Parameterscoderequired
kiotviet_list_categories
List categories
List product categories (id, name, parent, whether it has children). Set hierarchical to get the category tree. GET /categories.
Parametersorder_bypage_sizecurrent_itemhierarchicalorder_directionlast_modified_from
kiotviet_get_category
Get category
One product category by id (name, parent, children). GET /categories/{id}.
Parameterscategory_idrequired
kiotviet_list_customers
List customers
List customers (code, name, phone, email, address, debt, total invoiced, reward points, groups). Contains personal data of the shop's customers. Filter by code, name, phone, group or last change. GET /customers.
Parameterscodenamegroup_idorder_bypage_sizecurrent_iteminclude_totalcontact_numberorder_directionlast_modified_frominclude_customer_group
kiotviet_get_customer
Get customer
One customer by id: contact data, debt, total invoiced, reward points, groups. GET /customers/{id}.
Parameterscustomer_idrequired
kiotviet_get_customer_by_code
Get customer by code
One customer by customer code. GET /customers/code/{code}.
Parameterscoderequired
kiotviet_create_customer
Create customer
WRITE: create a new customer in the shop (name required; code is generated by KiotViet if omitted). Always check with the user first, and look the customer up by phone before creating a duplicate. POST /customers.
Parameterscodenamerequiredemailaddresscommentstax_codegroup_idsbirth_dateorganizationcontact_number
kiotviet_list_invoices
List invoices
List sales invoices (code, date, branch, customer, total, amount paid, status, lines). Filter by branch, customer, status, order, purchase-date range or last change. GET /invoices.
Parametersstatusorder_byorder_idpage_sizebranch_idscurrent_itemcustomer_idscustomer_codeinclude_paymentorder_directionto_purchase_datefrom_purchase_date+1 more
kiotviet_get_invoice
Get invoice
One invoice by id with its lines, payments and delivery. GET /invoices/{id}.
Parametersinvoice_idrequired
kiotviet_get_invoice_by_code
Get invoice by code
One invoice by invoice code (for example HD000123). GET /invoices/code/{code}.
Parameterscoderequired
kiotviet_list_orders
List sales orders
List sales orders (code, date, branch, customer, total, status, lines, delivery). Filter by branch, customer, status, creation date (from) or last change (from/to). GET /orders.
Parametersstatusorder_bypage_sizebranch_idscreated_datecurrent_itemcustomer_idscustomer_codeinclude_paymentorder_directionsale_channel_idlast_modified_to+2 more
kiotviet_get_order
Get sales order
One sales order by id with its lines, payments and delivery. GET /orders/{id}.
Parametersorder_idrequired
kiotviet_get_order_by_code
Get sales order by code
One sales order by order code (for example DH000123). GET /orders/code/{code}.
Parameterscoderequired
kiotviet_create_order
Create sales order
WRITE: create a sales order (an order, not an invoice: no invoice is made and no payment is recorded) with lines of existing products in a branch, for an existing customer or none. Always confirm the products, quantities and prices with the user first. POST /orders.
Parametersitemsrequireddiscountbranch_idrequiredsold_by_idcustomer_iddescriptionsale_channel_id
kiotviet_list_branches
List branches
List the shop's branches (id, name, code, phone, address). Use the ids to filter other tools. GET /branches.
Parameterspage_sizecurrent_item
kiotviet_list_stock
List stock on hand
Stock on hand and reserved quantity per product and branch. Filter by branch or last change. GET /productOnHands.
Parametersorder_bypage_sizebranch_idscurrent_itemorder_directionlast_modified_from
kiotviet_list_suppliers
List suppliers
List suppliers (code, name, phone, email, address, debt, total invoiced). Filter by code, name, phone or last change. GET /suppliers.
Parameterscodenamepage_sizecurrent_iteminclude_totalcontact_numberorder_directionlast_modified_from
kiotviet_get_supplier
Get supplier
One supplier by id. GET /suppliers/{id}.
Parameterssupplier_idrequired
kiotviet_list_purchase_orders
List goods receipts
List goods receipts from suppliers (nhap hang: code, date, branch, supplier, total, lines). Filter by branch, status or purchase-date range. GET /purchaseorders.
Parametersstatuspage_sizebranch_idscurrent_iteminclude_paymentto_purchase_datefrom_purchase_date
kiotviet_get_purchase_order
Get goods receipt
One goods receipt (nhap hang) by id with its lines. GET /purchaseorders/{id}.
Parameterspurchase_order_idrequired
kiotviet_list_supplier_orders
List supplier orders
List orders placed with suppliers (dat hang nhap: code, date, branch, supplier, status, lines, amount paid). Filter by branch, status, supplier or product text. GET /ordersuppliers.
Parametersstatuscode_keybranch_idpage_sizeproduct_keycurrent_itemsupplier_key
kiotviet_list_returns
List returns
List customer returns (code, date, branch, customer, invoice, return total, lines). GET /returns.
Parametersorder_bypage_sizecurrent_iteminclude_paymentorder_directionlast_modified_from
kiotviet_get_return
Get return
One customer return by id with its lines. GET /returns/{id}.
Parametersreturn_idrequired
kiotviet_list_cashflow
List cash flow
List cash-book entries (receipts and payments: code, branch, method, partner, amount, date, status). Filter by branch, direction or date range. GET /cashflow.
Parameterscodeend_datepage_sizebranch_idsis_receiptstart_datecurrent_itempartner_name
kiotviet_list_users
List users
List the shop's staff users (id, username, name, phone, email). GET /users.
Parameterspage_sizecurrent_item
kiotviet_list_price_books
List price books
List price books (bang gia: name, active flag, validity dates, branches, customer groups). GET /pricebooks.
Parameterspage_sizecurrent_iteminclude_branchesinclude_customer_groups
kiotviet_get_price_book
Get price book prices
The product prices of one price book (product id, code, price), paged. GET /pricebooks/{id}.
Parameterspage_sizecurrent_itemprice_book_idrequired