For AI agents: visit https://docs.smoothretail.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
v1.0
Log In
API Reference
Log In
v1.0
Guides
API Reference
Getting Started
Getting Started
Getting Started
SmoothPOS API
Accounts / AP Invoice
Create AP Invoice
post
Update AP Invoice
put
Approve Bulk
get
Cancel Bulk
get
Create Pay
post
List Payments
get
Get AP Invoice
get
Approve AP Invoice
get
Cancel AP Invoice
get
Delete AP Invoice
del
List AP Invoices
get
Accounts / AR Invoice
Create AR Invoice
post
Update AR Invoice
put
Approve Bulk
get
Get AR Invoice
get
Approve AR Invoice
get
Cancel AR Invoice
get
Get Paid
get
Delete AR Invoice
del
List AR Invoices
get
Accounts / Account
Create Account
post
Delete Account
del
Get Account
get
Update Account
put
Get Opening Balance
get
Get Statement Balance
get
Get System Balance
get
List Accounts
get
List GL Dates
get
Lock GL Entries
put
Accounts / Asset Write Off Reason
Create Asset Write Off Reason
post
Update Asset Write Off Reason
put
Delete Asset Write Off Reason
del
Get Asset Write Off Reason
get
List Asset Write Off Reasons
get
Accounts / Bank Statement
List Bankstatments
get
Accounts / Bank Transaction
Update Match
put
Get Transfer
get
Delete Bank Transaction
del
List Bank Transactions
get
Add Bank Transactions
post
Create Reconcile
post
Accounts / Cloud Print
Delete Account
del
Get Account
get
Create Account
post
Update Account
put
Accounts / Cost
Create Cost
post
List Costs
post
Accounts / Cost Centre
Create Costcentre
post
Update Costcentre
put
Get Costcentre
get
Delete Costcentre
del
List Costcentres
get
Accounts / Cost History
List Cost History
get
Accounts / Fixed Asset
Create Fixed Asset
post
Update Fixed Asset
put
Get Depreciate
get
Get Calculate
get
Depreciate Asset
get
Reverse Asset Depreciation
get
List Depreciations
get
Create Type
post
Update Type
put
Delete Type
del
Get Type
get
List Types
get
Get Fixed Asset
get
Get Active
get
Get Disposed
get
Get Sold
get
List Fixed Assets
get
Accounts / Journal
Create Journal
post
Get Journal
get
Reverse Journal
get
List Journals
get
List Entries
get
Get Count
get
Export Entries
get
Accounts / Payment Method
Create Payment Method
post
Update Payment Method
put
Delete Payment Method
del
Get Payment Method
get
List Paymentmethods
get
Accounts / Product
List Cost History
get
Accounts / Supplier
Create Supplier
post
Update Supplier
put
Delete Supplier
del
Get Supplier
get
List Suppliers
get
Accounts / Tax Rate
Create Tax Rate
post
Update Tax Rate
put
Get Tax Rate
get
Delete Tax Rate
del
List Taxrates
get
Admin / Calendar
Create Calendar
post
Get Day
get
Delete Calendar
del
Get Calendar
get
Get Month
get
Get Quarter
get
Get Week
get
Admin / Carrier
Create Carrier
post
Update Carrier
put
Delete Carrier
del
Get Carrier
get
List Carriers
get
Admin / Cloud Print
Get Client
get
Create Print
post
List Printers
get
Admin / Discount Reason
Create Discount Reason
post
Update Discount Reason
put
Delete Discount Reason
del
Get Discount Reason
get
List Discountreasons
get
Admin / Email Template
Create Email Template
post
Update Email Template
put
Get Email Template
get
Get Email Template
get
Delete Email Template
del
List Email Templates
get
Admin / File
Create Upload
post
Admin / My Company
Get My Company
get
Update My Company
put
Create Counter
post
List Counters
get
Delete Privatedata
del
Get Privatedata
get
Create Privatedata
post
Admin / Print Template
Create Print Template
post
Update Print Template
put
Get Print Template
get
Create Print Template
post
Get Print Template
get
Delete Print Template
del
List Print Templates
get
Admin / Return Reason
Create Return Reason
post
Update Return Reason
put
Delete Return Reason
del
Get Return Reason
get
List Return Reasons
get
Admin / Store
Create Store
post
Update Store
put
Delete Store
del
Get Store
get
List Stores
get
Customer / Customer
Create Customer
post
Update Customer
put
Delete Customer
del
Get Customer
get
Bulk Delete Customers
del
List Customers
get
Bulk Update Customers
post
Customer / Loyalty
Get Loyalty
get
Update Loyalty
put
Create Adjust
post
Update Recalc
get
Get Total
get
Enable Loyalty
get
Disable Loyalty
get
Extend Loyalty
get
Sales / Customer
List Store Credit Transactions
get
Employee / Employee
Create Employee
post
Update Employee
put
Get My Record
get
Get Employee
get
List Employees
get
List Inactive
get
Employee / Sales Staff
List POS Staff
get
Create POS Staff
post
Update POS Staff
put
List Terminated
get
Get POS Staff
get
Reinstate POS Staff
get
Terminate POS Staff
get
Employee / Unlinked Return
Allow Unlinked Returns
get
Deny Unlinked Returns
get
Glue / Glue
List Glue
get
Create Glue
post
Update Glue
put
Delete Error
del
Get Error
get
List Errors
get
List Functions
get
Create Test
post
Delete Glue
del
Get Glue
get
Inventory / Box
Create Box
post
Update Box
put
Delete Box
del
Get Box
get
List Boxes
get
Inventory / Inventory
Create Adjust
post
Create Location
post
Update Location
put
Delete Location
del
Get Location
get
List Locations
get
Create Move
post
Get All
get
Create Inventory
post
Inventory / Minimum Stock Quantity
Update Minimum Stock Quantity
put
Get Product
get
Get Product
get
Get Minimum Stock Quantity for Warehouse
get
Get Minimum Stock Quantity for Warehouse / Product
get
Get Minimum Stock Quantity for Warehouse / Product / Item
get
Inventory / Product
Get Inventory
get
Get Total
get
Get Inventory
get
Get Total
get
Get Inventory
get
List Inventory Movements
get
Get Inventory Movement
get
Get Inventory Movements For Location
get
Inventory / Purchase Order
Create Purchase Order
post
Update Purchase Order
put
Get Purchase Order
get
Cancel Purchase Order
get
Complete Purchase Order
get
Get Matched
get
Ship Purchase Order
get
List Purchaseorders
get
Inventory / Replenishment
Create Replenishment
post
Update Replenishment
put
Get Replenishment
get
Run Replenishment
get
Delete Replenishment
del
List Replenishments
get
Inventory / Shipping Cost
Add Shipping Cost
post
Update Shipping Cost
put
Delete Shipping Cost
del
List Shipping Costs
get
Inventory / Stock Adjustment Reason
Create Stock Adjustment Reason
post
Update Stock Adjustment Reason
put
Delete Stock Adjustment Reason
del
Get Stock Adjustment Reason
get
List Stock Adjustment Reasons
get
Inventory / Stocktake
Create Stocktake
post
Delete Stocktake
del
Get Stocktake
get
Update Addcount
put
Complete Stocktake
get
Get Variance
get
Complete Stocktake
get
List Inprogress
get
List Open
get
Inventory / Transfer
Create Transfer
post
Update Transfer
put
Get Transfer
get
Cancel Transfer
get
Receive Transfer
get
List Transfers
get
Inventory / Warehouse
Create Warehouse
post
Update Warehouse
put
Delete Warehouse
del
Get Warehouse
get
Get In Transit
get
Get Inventory
get
Get Total
get
Get Inventory
get
Get Total
get
Get Inventory
get
Get Total
get
Get Inventory
get
List Inventory Movements
get
Get Inventory Movements For Product
get
Get Inventory Movements For Item
get
Get Inventory Movements For Item Location
get
List Warehouses
get
Product / Item
Get Barcode
get
List Items
get
Product / Price
Update Price
put
Delete Price
del
Get Price
get
List Prices
del
List Prices
get
List Prices
post
Delete Deleted
get
Product / Product
Create Product
post
Update Product
put
Delete Product
del
Get Product
get
Create Item
post
Update Item
put
Get Item
get
Get Current Price
get
List Items
get
List Products
del
List Products
get
List Products
post
Delete Deleted
get
Export Products
get
Delete Deleted
get
List Types
get
List Vendors
get
Product / Promotion
Create Promotion
post
Update Promotion
put
Delete Promotion
del
Get Promotion
get
List Promotions
get
Product / Quick Product Buy
Create Quick Product Buy
post
Reports / Log
List Log
get
Create Log
post
Get Log
get
Reports / Report
Create Report
post
Update Report
put
Export Report
post
Run Report
post
Delete Report
del
Get Report
get
List Reports
get
Sales / Fulfillment
Create Fulfillment
post
Update Fulfillment
put
List Generate Pick
get
Update Shipment
put
Get Fulfillment
get
Complete Fulfillment
get
Complete Fulfillment
get
List In Progress
get
Get Integrated Refund
get
Create Return
post
Ship Fulfillment
post
List Fulfillments
get
Sales / Gift Card
Create Gift Card
post
Update Gift Card
put
Get Gift Card
get
List Gift Cards
get
Sales / Gift Card Reason
Create Gift Card Reason
post
Update Gift Card Reason
put
Delete Gift Card Reason
del
Get Gift Card Reason
get
List Gift Card Reasons
get
Sales / Payment
Create Payment
post
Get Payment
get
List Payments
get
List Payments
post
Sales / Product
Get Awaiting Fulfillment
get
Sales / Sale
Create Sale
post
Get Customer
get
Create Email Receipt
post
Get Employee
get
Get Sale
get
List Payments
get
List Payments
post
List Sales
get
List Sales
post
Get Sold
get
Get Sold
get
Get Sold
get
Sales / Sale Line
List Sale Lines
get
Sales / Sales Budget
List Sales Budget
get
Update Sales Budget
put
Sales / Shipment
Create Shipment
post
Update Shipment
put
Get Shipment
get
Get Arrived
get
Cancel Shipment
get
Ship Shipment
get
List Shipments
get
List Lines
get
Sales / Store Credit
Create Adjust
post
Sales / Store Credit Reason
Create Store Credit Reason
post
Update Store Credit Reason
put
Delete Store Credit Reason
del
Get Store Credit Reason
get
List Storecreditreasons
get
Sales / Warehouse
Get Awaiting Fulfillment
get
Get Awaiting Fulfillment
get
Powered by
Copy Page
Getting Started
Updated about 1 month ago
Accounts / AP Invoice
Did this page help you?
Yes
No
Updated about 1 month ago
Accounts / AP Invoice
Did this page help you?
Yes
No
