{"openapi":"3.0.1","info":{"title":"STEL Order API","description":"STEL Order API Documentation
To use our API you must have an APIKEY (Secret) provided by a STEL Order superadmin account from https://stelorder.com/app -> Functionalities -> API -> New or get existing.
This APIKEY must be included in every request, you can include it in GET/POST parameter or as HEADER value (NOTE: Do not include {}), please do not share this API key unless you know what you are doing. This APIKEY is intended to be used only in a System-to-System communication environment. DISCLAIMER: STEL Solutions is not responsible of stolen APIKEY's and unauthorized accesses using it. If you suspect that your APIKEY have been stolen you can disable it and generate a new one in STEL Order Website.
\tExamples of calls:
https://app.stelorder.com/app/clients?APIKEY=[YOURAPIKEY]
curl -H \"APIKEY: [YOURAPIKEY]\" https://app.stelorder.com/app/clients
curl https://app.stelorder.com/app/clients?APIKEY=[YOURAPIKEY]
curl --data \"APIKEY=[YOURAPIKEY]\" https://app.stelorder.com/app/clients
curl -H \"APIKEY: [YOURAPIKEY]\" -X POST https://app.stelorder.com/app/clients -d \"DATA IN JSON FORMAT\"
You can filter by null using IS_NULL_VALUE and not null using IS_NOT_NULL_VALUE (Example of contact without client associated: https://app.stelorder.com/app/contacts?account-id=IS_NULL_VALUE)
Deleted elements can only be obtained using GET by ID, you cannot modify a deleted element.
This API works with this ISO 8601 date format: \"yyyy-MM-dd'T'HH:mm:ssZ\".
POST and PUT commands must contains only one JSON element, batch loads on the same request isn't supported, make multiple requests instead. We will only process the first element.
There are different usage limits depending on the plan:
- Lite: 60 API calls/minute and 300 API calls/day
- Business: 60 API calls/minute and 1000 API calls/day
- Pro: 60 API calls/minute and 2000 API calls/day
","termsOfService":"https://www.stelorder.com/en/terms-of-use/","contact":{"name":"STEL Solutions","url":"https://www.stelorder.com/en/","email":"info@stelorder.com"},"version":"1.0.0"},"tags":[{"name":"SerialNumbers","description":"Available endpoints for SERIAL NUMBERS:
GET https://app.stelorder.com/app/serialNumbers Will return an unfiltered and unordered list of all Serial Numbers (limited to 100 by default)
\tGET https://app.stelorder.com/app/serialNumbers/{ID} Will return a Serial Number with provided ID (NOTE: Do not include {})
"},{"name":"ProductCategories","description":"Available endpoints for PRODUCT CATEGORIES:
GET https://app.stelorder.com/app/productCategories Will return an unfiltered and unordered list of all Product Categories (limited to 100 by default)
\tGET https://app.stelorder.com/app/productCategories/{ID} Will return a Product Category with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/productCategories Create a new Product Category and return his info
\tPUT https://app.stelorder.com/app/productCategories/{ID} Modify Product Category data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/productCategories/{ID} Delete a Product Categoty with provided ID (NOTE: Do not include {})
"},{"name":"ExpenseCategories","description":"Available endpoints for EXPENSE CATEGORIES:
GET https://app.stelorder.com/app/expenseCategories Will return an unfiltered and unordered list of all Expense Categories (limited to 100 by default)
\tGET https://app.stelorder.com/app/expenseCategories/{ID} Will return an Expense Category with provided ID (NOTE: Do not include {})
"},{"name":"AccountCategories","description":"Available endpoints for ACCOUNT CATEGORIES:
GET https://app.stelorder.com/app/accountCategories Will return an unfiltered and unordered list of all Account Categories (limited to 100 by default)
\tGET https://app.stelorder.com/app/accountCategories/{ID} Will return an Account Category with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/accountCategories Create a new Account Category and return his info
\tPUT https://app.stelorder.com/app/accountCategories/{ID} Modify Account Category data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/accountCategories/{ID} Delete an Account Categoty with provided ID (NOTE: Do not include {})
"},{"name":"Rates","description":"Available endpoints for RATES:
GET https://app.stelorder.com/app/rates Will return an unfiltered and unordered list of all Rates (limited to 100 by default)
\tGET https://app.stelorder.com/app/rates/{ID} Will return a Rate with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/rates Create a new Rate and return his info
\tPUT https://app.stelorder.com/app/rates/{ID} Modify Rate data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/rates/{ID} Delete a Rate with provided ID (NOTE: Do not include {})
"},{"name":"ItemRates","description":"Available endpoints for ITEM RATES:
GET https://app.stelorder.com/app/itemRates Will return an unfiltered and unordered list of all Item Rates (limited to 100 by default)
\tPUT https://app.stelorder.com/app/itemRates Modify Item Rate data and return his info (NOTE: Do not include {})
"},{"name":"SpecialPrices","description":"Available endpoints for SPECIAL PRICES:
GET https://app.stelorder.com/app/specialPrices Will return an unfiltered and unordered list of all Special Prices (limited to 100 by default)
\tGET https://app.stelorder.com/app/specialPrices/{ID} Will return a Special Price with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/specialPrices Create a new Special Price and return his info
\tPUT https://app.stelorder.com/app/specialPrices/{ID} Modify Special Price data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/specialPrices/{ID} Delete a Special Price with provided ID (NOTE: Do not include {})
"},{"name":"ProductComponents","description":"Available endpoints for PRODUCT COMPONENTS:
GET https://app.stelorder.com/app/productComponents Will return an unfiltered and unordered list of all Product Components (limited to 100 by default)
\tGET https://app.stelorder.com/app/productComponents/{ID} Will return a Product Component with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/productComponents Create a new Product Component and return his info
\tPUT https://app.stelorder.com/app/productComponents/{ID} Modify Product Component data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/productComponents/{ID} Delete a Product Component with provided ID (NOTE: Do not include {})
"},{"name":"Warehouses","description":"Available endpoints for WAREHOUSES:
GET https://app.stelorder.com/app/warehouses Will return an unfiltered and unordered list of all Warehouses (limited to 100 by default)
\tGET https://app.stelorder.com/app/warehouses/{ID} Will return a Warehouse with provided ID (NOTE: Do not include {})
"},{"name":"ProductWarehouses","description":"Available endpoints for PRODUCT WAREHOUSES:
GET https://app.stelorder.com/app/productWarehouses Will return an unfiltered and unordered list of all Product Warehouses (limited to 100 by default)
\tPUT https://app.stelorder.com/app/productWarehouses Modify Product Warehouse data and return his info (NOTE: Do not include {})
"},{"name":"StockMovements","description":"Available endpoints for STOCK MOVEMENTS:
GET https://app.stelorder.com/app/stockMovements Will return an unfiltered and unordered list of all Stock Movements (limited to 100 by default)
"},{"name":"ItemImages","description":"Available endpoints for ITEM IMAGES:
GET https://app.stelorder.com/app/itemImages Will return an unfiltered and unordered list of all Item Images (limited to 100 by default)
\tGET https://app.stelorder.com/app/itemImages/{ID} Will return an Item Image with provided ID (NOTE: Do not include {})
POST https://app.stelorder.com/app/itemImages Create a new Item Image and return his info
\tDELETE https://app.stelorder.com/app/itemImages/{ID} Delete an Item Image with provided ID (NOTE: Do not include {})
"},{"name":"AssetImages","description":"Available endpoints for ASSET IMAGES:
GET https://app.stelorder.com/app/issetImages Will return an unfiltered and unordered list of all Asset Images (limited to 100 by default)
\tGET https://app.stelorder.com/app/assetImages/{ID} Will return an Asset Image with provided ID (NOTE: Do not include {})
POST https://app.stelorder.com/app/assetImages Create a new Asset Image and return his info
\tDELETE https://app.stelorder.com/app/assetImages/{ID} Delete an Asset Image with provided ID (NOTE: Do not include {})
"},{"name":"TaxLines","description":"Available endpoints for TAX LINES:
GET https://app.stelorder.com/app/taxLines Will return an unfiltered and unordered list of all Tax Lines (limited to 100 by default)
\tGET https://app.stelorder.com/app/taxLines/{ID} Will return a tax line with provided ID (NOTE: Do not include {})
"},{"name":"Employees","description":"Available endpoints for EMPLOYEES:
GET https://app.stelorder.com/app/employees Will return an unfiltered and unordered list of all Employees (limited to 100 by default)
\tGET https://app.stelorder.com/app/employees/{ID} Will return an Employe with provided ID (NOTE: Do not include {})
"},{"name":"EmployeeRoles","description":"Available endpoints for EMPLOYEE ROLES:
GET https://app.stelorder.com/app/employeeRoles Will return an unfiltered and unordered list of all Employee Roles (limited to 100 by default)
\tGET https://app.stelorder.com/app/employeeRoles/{ID} Will return an Employe Role with provided ID (NOTE: Do not include {})
"},{"name":"PaymentOptions","description":"Available endpoints for PAYMENT OPTIONS:
GET https://app.stelorder.com/app/paymentOptions Will return an unfiltered and unordered list of all Payment Options (limited to 100 by default)
\tGET https://app.stelorder.com/app/paymentOptions/{ID} Will return a Payment Options with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/paymentOptions Create a new Payment Option and return its info
\tPUT https://app.stelorder.com/app/paymentOptions/{ID} Modify Payment Option data and return its info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/paymentOptions/{ID} Delete a Payment Option with provided ID (NOTE: Do not include {})
"},{"name":"PaymentTerms","description":"Available endpoints for PAYMENT TERMS:
GET https://app.stelorder.com/app/paymentTerms Will return an unfiltered and unordered list of all Payment Terms (limited to 100 by default)
\tGET https://app.stelorder.com/app/paymentTerms/{ID} Will return a Payment Terms with provided ID (NOTE: Do not include {})
"},{"name":"DeliveryOptions","description":"Available endpoints for DELIVERY OPTIONS:
GET https://app.stelorder.com/app/deliveryOptions Will return an unfiltered and unordered list of all Delivery Options (limited to 100 by default)
\tGET https://app.stelorder.com/app/deliveryOptions/{ID} Will return a Delivery Option with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/deliveryOptions Create a new Delivery Option and return his info
\tPUT https://app.stelorder.com/app/deliveryOptions/{ID} Modify Delivery Option data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/deliveryOptions/{ID} Delete a Delivery Option with provided ID (NOTE: Do not include {})
"},{"name":"BankAccounts","description":"Available endpoints for BANK ACCOUNTS:
GET https://app.stelorder.com/app/bankAccounts Will return an unfiltered and unordered list of all Bank Accounts (limited to 100 by default)
\tGET https://app.stelorder.com/app/bankAccounts/{ID} Will return a Bank Accounts with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/bankAccounts Create a new Bank Account and return his info
\tPUT https://app.stelorder.com/app/bankAccounts/{ID} Modify Bank Account data and return his info (NOTE: Do not include {})
"},{"name":"Addresses","description":"Available endpoints for ADDRESSES:
GET https://app.stelorder.com/app/addresses Will return an unfiltered and unordered list of all Addresses (limited to 100 by default)
\tGET https://app.stelorder.com/app/addresses/{ID} Will return an Address with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/addresses Create a new Address and return his info (Non DEFAULT Address)
\tPUT https://app.stelorder.com/app/addresses/{ID} Modify Address data and return his info (Non DEFAULT Address) (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/addresses/{ID} Delete an Address with provided ID (Non DEFAULT Address) (NOTE: Do not include {})
"},{"name":"OrdinaryInvoiceReceipts","description":"Available endpoints for ORDINARY INVOICE RECEIPTS:
GET https://app.stelorder.com/app/ordinaryInvoiceReceipts Will return an unfiltered and unordered list of all Ordinary Invoice Receipts (limited to 100 by default)
\tGET https://app.stelorder.com/app/ordinaryInvoiceReceipts/{ID} Will return an Ordinary Invoice Receipts with provided ID (NOTE: Do not include {})
\tPUT https://app.stelorder.com/app/ordinaryInvoiceReceipts/{ID} Modify Ordinary Invoice Receipt data and return his info (NOTE: Do not include {})
"},{"name":"RefundInvoiceReceipts","description":"Available endpoints for REFUND INVOICE RECEIPTS:
GET https://app.stelorder.com/app/refundInvoiceReceipts Will return an unfiltered and unordered list of all Refund Invoice Receipts (limited to 100 by default)
\tGET https://app.stelorder.com/app/refundInvoiceReceipts/{ID} Will return an Refund Invoice Receipts with provided ID (NOTE: Do not include {})
\tPUT https://app.stelorder.com/app/refundInvoiceReceipts/{ID} Modify Refund Invoice Receipt data and return his info (NOTE: Do not include {})
"},{"name":"PurchaseInvoiceReceipts","description":"Available endpoints for PURCHASE INVOICE RECEIPTS:
GET https://app.stelorder.com/app/purchaseInvoiceReceipts Will return an unfiltered and unordered list of all Purchase Invoice Receipts (limited to 100 by default)
\tGET https://app.stelorder.com/app/purchaseInvoiceReceipts/{ID} Will return an Purchase Invoice Receipts with provided ID (NOTE: Do not include {})
\tPUT https://app.stelorder.com/app/purchaseInvoiceReceipts/{ID} Modify Purchase Invoice Receipt data and return his info (NOTE: Do not include {})
"},{"name":"DocumentStates","description":"Available endpoints for DOCUMENT STATES:
GET https://app.stelorder.com/app/documentStates Will return an unfiltered and unordered list of all Document States (limited to 100 by default)
\tGET https://app.stelorder.com/app/documentStates/{ID} Will return an Document States with provided ID (NOTE: Do not include {})
"},{"name":"IncidentStates","description":"Available endpoints for INCIDENT STATES:
GET https://app.stelorder.com/app/incidentStates Will return an unfiltered and unordered list of all Incident States (limited to 100 by default)
\tGET https://app.stelorder.com/app/incidentStates/{ID} Will return an Incident States with provided ID (NOTE: Do not include {})
"},{"name":"ExpenseStates","description":"Available endpoints for EXPENSE STATES:
GET https://app.stelorder.com/app/expenseStates Will return an unfiltered and unordered list of all Expense States (limited to 100 by default)
\tGET https://app.stelorder.com/app/expenseStates/{ID} Will return an Expense States with provided ID (NOTE: Do not include {})
"},{"name":"IncidentTypes","description":"Available endpoints for INCIDENT TYPES:
GET https://app.stelorder.com/app/incidentTypes Will return an unfiltered and unordered list of all Incident Types (limited to 100 by default)
\tGET https://app.stelorder.com/app/incidentTypes/{ID} Will return an Incident Type with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/incidentTypes Create a new Incident Type and return his info
\tPUT https://app.stelorder.com/app/incidentTypes/{ID} Modify Incident Type data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/incidentTypes/{ID} Delete an Incident Type with provided ID (NOTE: Do not include {})
"},{"name":"EventTypes","description":"Available endpoints for EVENT TYPES:
GET https://app.stelorder.com/app/eventTypes Will return an unfiltered and unordered list of all Event Types (limited to 100 by default)
\tGET https://app.stelorder.com/app/eventsTypes/{ID} Will return an Event Type with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/eventTypes Create a new Event Type and return his info
\tPUT https://app.stelorder.com/app/eventTypes/{ID} Modify Event Type data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/eventTypes/{ID} Delete an Event Type with provided ID (NOTE: Do not include {})
"},{"name":"Products","description":"Available endpoints for PRODUCTS:
GET https://app.stelorder.com/app/products Will return an unfiltered and unordered list of all Products (limited to 100 by default)
\tGET https://app.stelorder.com/app/products/{ID} Will return a Product with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/products Create a new Product and return his info
\tPUT https://app.stelorder.com/app/products/{ID} Modify Product data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/product/{ID} Delete a Product with provided ID (NOTE: Do not include {})
"},{"name":"Services","description":"Available endpoints for SERVICES:
GET https://app.stelorder.com/app/services Will return an unfiltered and unordered list of all Services (limited to 100 by default)
\tGET https://app.stelorder.com/app/services/{ID} Will return a Service with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/services Create a new Service and return his info
\tPUT https://app.stelorder.com/app/services/{ID} Modify Service data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/services/{ID} Delete a Service with provided ID (NOTE: Do not include {})
"},{"name":"ExpensesAndInvestments","description":"Available endpoints for EXPENSES AND INVESTMENTS:
GET https://app.stelorder.com/app/expensesAndInvestments Will return an unfiltered and unordered list of all Expenses and Investments (limited to 100 by default)
\tGET https://app.stelorder.com/app/expensesAndInvestments/{ID} Will return an Expense or Investment with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/expensesAndInvestments Create a new Expense or Investment and return his info
\tPUT https://app.stelorder.com/app/expensesAndInvestments/{ID} Modify Expense or Investment data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/expensesAndInvestments/{ID} Delete an Expense or Investment with provided ID (NOTE: Do not include {})
"},{"name":"Assets","description":"Available endpoints for ASSETS:
GET https://app.stelorder.com/app/assets Will return an unfiltered and unordered list of all Assets (limited to 100 by default)
\tGET https://app.stelorder.com/app/assets/{ID} Will return an Asset with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/assets Create a new Asset and return his info
\tPUT https://app.stelorder.com/app/assets/{ID} Modify Asset data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/assets/{ID} Delete an Asset with provided ID (NOTE: Do not include {})
"},{"name":"Clients","description":"Available endpoints for CLIENTS:
GET https://app.stelorder.com/app/clients Will return an unfiltered and unordered list of all Clients (limited to 100 by default)
\tGET https://app.stelorder.com/app/clients/{ID} Will return a Client with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/clients Create a new Client and return his info
\tPUT https://app.stelorder.com/app/clients/{ID} Modify Client data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/clients/{ID} Delete a Client with provided ID (NOTE: Do not include {})
"},{"name":"PotentialClients","description":"Available endpoints for POTENTIAL CLIENTS:
GET https://app.stelorder.com/app/potentialClients Will return an unfiltered and unordered list of all Potential Clients (limited to 100 by default)
\tGET https://app.stelorder.com/app/potentialClients/{ID} Will return a Potential Client with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/potentialClients Create a new Potential Client and return his info
\tPUT https://app.stelorder.com/app/potentialClients/{ID} Modify Potential Client data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/potentialClients/{ID} Delete a Potential Client with provided ID (NOTE: Do not include {})
"},{"name":"Suppliers","description":"Available endpoints for SUPPLIERS:
GET https://app.stelorder.com/app/suppliers Will return an unfiltered and unordered list of all Suppliers (limited to 100 by default)
\tGET https://app.stelorder.com/app/suppliers/{ID} Will return a Supplier with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/suppliers Create a new Supplier and return his info
\tPUT https://app.stelorder.com/app/suppliers/{ID} Modify Supplier data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/suppliers/{ID} Delete a Supplier with provided ID (NOTE: Do not include {})
"},{"name":"Contacts","description":"Available endpoints for CONTACTS:
GET https://app.stelorder.com/app/contacts Will return an unfiltered and unordered list of all Contacts (limited to 100 by default)
\tGET https://app.stelorder.com/app/contacts/{ID} Will return a Contact with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/contacts Create a new Contact and return his info
\tPUT https://app.stelorder.com/app/contacts/{ID} Modify Contact data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/contacts/{ID} Delete a Contact with provided ID (NOTE: Do not include {})
"},{"name":"SalesEstimates","description":"Available endpoints for SALES ESTIMATES:
GET https://app.stelorder.com/app/salesEstimates Will return an unfiltered and unordered list of all Sales Estimates (limited to 100 by default)
\tGET https://app.stelorder.com/app/salesEstimates/{ID} Will return a Sales Estimate with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/salesEstimates Create a new Sales Estimate and return his info
\tPUT https://app.stelorder.com/app/salesEstimates/{ID} Modify sales Estimate data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/salesEstimates/{ID} Delete a Sales Estimate with provided ID (NOTE: Do not include {})
"},{"name":"SalesOrders","description":"Available endpoints for SALES ORDERS:
GET https://app.stelorder.com/app/salesOrders Will return an unfiltered and unordered list of all Sales Orders (limited to 100 by default)
\tGET https://app.stelorder.com/app/salesOrders/{ID} Will return a Sales Order with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/salesOrders Create a new Sales Order and return his info
\tPUT https://app.stelorder.com/app/salesOrders/{ID} Modify Sales Order data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/salesOrders/{ID} Delete a Sales Order with provided ID (NOTE: Do not include {})
"},{"name":"SalesDeliveryNotes","description":"Available endpoints for SALES DELIVERY NOTES:
GET https://app.stelorder.com/app/salesDeliveryNotes Will return an unfiltered and unordered list of all Sales Delivery Notes (limited to 100 by default)
\tGET https://app.stelorder.com/app/salesDeliveryNotes/{ID} Will return a Sales Delivery Note with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/salesDeliveryNotes Create a new Sales Delivery Note and return his info
\tPUT https://app.stelorder.com/app/salesDeliveryNotes/{ID} Modify Sales Delivery Note data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/salesDeliveryNotes/{ID} Delete a Sales Delivery Note with provided ID (NOTE: Do not include {})
"},{"name":"Incidents","description":"Available endpoints for INCIDENTS:
\tGET https://app.stelorder.com/app/incidents/{ID} Will return an Incident with provided ID (NOTE: Do not include {})
GET https://app.stelorder.com/app/incidents Will return an unfiltered and unordered list of all Incidents (limited to 100 by default)
\tPOST https://app.stelorder.com/app/incidents Create a new Incident and return his info
\tPUT https://app.stelorder.com/app/incidents/{ID} Modify Incident data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/incidents/{ID} Delete an Incident with provided ID (NOTE: Do not include {})
"},{"name":"WorkEstimates","description":"Available endpoints for WORK ESTIMATES:
GET https://app.stelorder.com/app/workEstimates Will return an unfiltered and unordered list of all Work Estimates (limited to 100 by default)
\tGET https://app.stelorder.com/app/workEstimates/{ID} Will return a Work Estimate with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/workEstimates Create a new Work Estimate and return his info
\tPUT https://app.stelorder.com/app/workEstimates/{ID} Modify Work Estimate data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/workEstimates/{ID} Delete a Work Estimate with provided ID (NOTE: Do not include {})
"},{"name":"WorkOrders","description":"Available endpoints for WORK ORDERS:
GET https://app.stelorder.com/app/workOrders Will return an unfiltered and unordered list of all Work Orders (limited to 100 by default)
\tGET https://app.stelorder.com/app/workOrders/{ID} Will return a Work Order with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/workOrders Create a new Work Order and return his info
\tPUT https://app.stelorder.com/app/workOrders/{ID} Modify Work Order data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/workOrders/{ID} Delete a Work Order with provided ID (NOTE: Do not include {})
"},{"name":"WorkDeliveryNotes","description":"Available endpoints for WORK DELIVERY NOTES:
GET https://app.stelorder.com/app/workDeliveryNotes Will return an unfiltered and unordered list of all Work Delivery Notes (limited to 100 by default)
\tGET https://app.stelorder.com/app/workDeliveryNotes/{ID} Will return a Work Delivery Note with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/workDeliveryNotes Create a new Work Delivery Note and return his info
\tPUT https://app.stelorder.com/app/workDeliveryNotes/{ID} Modify Work Delivery Note data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/workOrders/{ID} Delete a Work Delivery Note with provided ID (NOTE: Do not include {})
"},{"name":"OrdinaryInvoices","description":"Available endpoints for ORDINARY INVOICES:
GET https://app.stelorder.com/app/ordinaryInvoices Will return an unfiltered and unordered list of all Ordinary Invoices (limited to 100 by default)
\tGET https://app.stelorder.com/app/ordinaryInvoices/{ID} Will return an Ordinary Invoice with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/ordinaryInvoices Create a new Ordinary Invoice and return his info
\tPUT https://app.stelorder.com/app/ordinaryInvoices/{ID} Modify Ordinary Invoice data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/ordinaryInvoices/{ID} Delete an Ordinary Invoice with provided ID (NOTE: Do not include {})
"},{"name":"RefundInvoices","description":"Available endpoints for REFUND INVOICES:
GET https://app.stelorder.com/app/refundInvoices Will return an unfiltered and unordered list of all Refund Invoices (limited to 100 by default)
\tGET https://app.stelorder.com/app/refundInvoices/{ID} Will return a Refund Invoice with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/refundInvoices Create a new Refund Invoice and return his info
\tPUT https://app.stelorder.com/app/refundInvoices/{ID} Modify Refund Invoice data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/refundInvoices/{ID} Delete a Refund Invoice with provided ID (NOTE: Do not include {})
"},{"name":"PurchaseOrders","description":"Available endpoints for PURCHASE ORDERS:
GET https://app.stelorder.com/app/purchaseOrders Will return an unfiltered and unordered list of all Purchase Orders (limited to 100 by default)
\tGET https://app.stelorder.com/app/purchaseOrders/{ID} Will return a Purchase Order with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/purchaseOrders Create a new Purchase Order and return his info
\tPUT https://app.stelorder.com/app/purchaseOrders/{ID} Modify Purchase Order data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/purchaseOrders/{ID} Delete a Purchase Order with provided ID (NOTE: Do not include {})
"},{"name":"PurchaseDeliveryNotes","description":"Available endpoints for PURCHASE DELIVERY NOTES:
GET https://app.stelorder.com/app/purchaseDeliveryNotes Will return an unfiltered and unordered list of all Purchase Delivery Notes (limited to 100 by default)
\tGET https://app.stelorder.com/app/purchaseDeliveryNotes/{ID} Will return a purchase Delivery Note with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/purchaseDeliveryNotes Create a new Purchase Delivery Note and return his info
\tPUT https://app.stelorder.com/app/purchaseDeliveryNotes/{ID} Modify Purchase Delivery Note data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/purchaseDeliveryNotes/{ID} Delete a Purchase Delivery Note with provided ID (NOTE: Do not include {})
"},{"name":"PurchaseInvoices","description":"Available endpoints for PURCHASE INVOICES:
GET https://app.stelorder.com/app/purchaseInvoices Will return an unfiltered and unordered list of all Purchase Invoices (limited to 100 by default)
\tGET https://app.stelorder.com/app/purchaseInvoices/{ID} Will return an Purchase Invoice with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/purchaseInvoices Create a new Purchase Invoice and return his info
\tPUT https://app.stelorder.com/app/purchaseInvoices/{ID} Modify Purchase Invoice data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/purchaseInvoices/{ID} Delete an Purchase Invoice with provided ID (NOTE: Do not include {})
"},{"name":"Expenses","description":"Available endpoints for EXPENSES:
GET https://app.stelorder.com/app/expenses Will return an unfiltered and unordered list of all Expenses (limited to 100 by default)
\tGET https://app.stelorder.com/app/expenses/{ID} Will return a Expense with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/expenses Create a new Expense and return his info
\tPUT https://app.stelorder.com/app/expenses/{ID} Modify Expense data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/expenses/{ID} Delete an Expense with provided ID (NOTE: Do not include {})
"},{"name":"Calendars","description":"Available endpoints for CALENDARS:
GET https://app.stelorder.com/app/calendars Will return an unfiltered and unordered list of all Calendars (limited to 100 by default)
\tGET https://app.stelorder.com/app/calendars/{ID} Will return a Calendar with provided ID (NOTE: Do not include {})
"},{"name":"Events","description":"Available endpoints for EVENTS:
GET https://app.stelorder.com/app/events Will return an unfiltered and unordered list of all Events (limited to 100 by default)
\tGET https://app.stelorder.com/app/events/{ID} Will return an Event with provided ID (NOTE: Do not include {})
\tPOST https://app.stelorder.com/app/events Create a new Event and return his info
\tPUT https://app.stelorder.com/app/events/{ID} Modify Event data and return his info (NOTE: Do not include {})
\tDELETE https://app.stelorder.com/app/events/{ID} Delete an Event with provided ID (NOTE: Do not include {})
"},{"name":"ShopItems","description":"Available endpoints for SHOP ITEMS:
GET https://app.stelorder.com/app/shopItems Will return an unfiltered and unordered list of all Shop Items (limited to 100 by default)
"},{"name":"TempoEmployees","description":"Available endpoints for TEMPOEMPLOYEES:
GET https://app.stelorder.com/app/tempoEmployees Will return an unfiltered and unordered list of all TempoEmployees (limited to 100 by default)
\tGET https://app.stelorder.com/app/tempoEmployees/{ID} Will return an TempoEmploye with provided ID (NOTE: Do not include {})
"},{"name":"EntityAttachments","description":"Available endpoint for ENTITY ATTACHMENTS:
GET https://app.stelorder.com/app/entityAttachments Will return an unfiltered and unordered list of all Attachments (limited to 100 by default)
GET https://app.stelorder.com/app/entityAttachments/{ID}/download Will return the binary content of the Attachment with the provided ID
POST https://app.stelorder.com/app/entityAttachments Create a new attachment and return his info
"},{"name":"IssueInvoiceVerifactu","description":"Available endpoints for ISSUE INVOICE VERIFACTU:
\tPOST https://app.stelorder.com/app/issueInvoiceVerifactu Issue an Ordinary Invoice or a Refund Invoice as Verifactu and return his info
"},{"name":"SendDocument","description":"Available endpoints for SEND A DOCUMENT by email:
\tPOST https://app.stelorder.com/app/sendDocument Send a document by email
"},{"name":"ErrorCodes","description":"Available endpoints for ERROR CODES:
GET https://app.stelorder.com/app/errorCodes Will return all the STEL Order API Error Codes
"}],"paths":{"/{version}/{context}/entity/{entityName}":{"options":{"operationId":"getEntityOptions","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"entityName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/entity/{type}/{id}/{attribute}":{"get":{"operationId":"findAttribute","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"setOrAddAttribute","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"delete":{"operationId":"removeAttribute","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/entity/{type}":{"put":{"operationId":"create","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"update","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/entity/{type}/{id}":{"get":{"operationId":"find","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"delete":{"operationId":"delete","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/metadata-catalog/query/{queryName}":{"get":{"operationId":"getQueryResource","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/schema+json":{}}}}}},"/{version}/{context}/metadata-catalog/entity/{entityName}":{"get":{"operationId":"getEntityResource","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"entityName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/schema+json":{}}}}}},"/{version}/{context}/metadata-catalog":{"get":{"operationId":"getMetadataCatalog","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/{version}":{"get":{"operationId":"getContexts","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"callSessionBean","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/{version}/{context}/metadata":{"get":{"operationId":"getTypes","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/metadata/query/{queryName}":{"get":{"operationId":"getQueryMetadata","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/metadata/entity/{descriptorAlias}":{"get":{"operationId":"getDescriptorMetadata","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"descriptorAlias","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/metadata/query":{"get":{"operationId":"getQueriesMetadata","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/query/{name}":{"get":{"operationId":"namedQuery","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"namedQueryUpdate","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"options":{"operationId":"getQueryOptions","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{version}/{context}/singleResultQuery/{name}":{"get":{"operationId":"namedQuerySingleResult","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}},{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"application/octet-stream":{}}}}}},"/{context}/entity/{type}/{id}/{attribute}":{"get":{"operationId":"findAttribute_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"setOrAddAttribute_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"delete":{"operationId":"removeAttribute_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{context}/entity/{type}":{"put":{"operationId":"create_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"update_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{context}/entity/{type}/{id}":{"get":{"operationId":"find_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"delete":{"operationId":"delete_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/":{"get":{"operationId":"getContexts_1","responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"callSessionBean_1","requestBody":{"content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/{context}/metadata":{"get":{"operationId":"getTypes_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{context}/metadata/query/{queryName}":{"get":{"operationId":"getQueryMetadata_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{context}/metadata/entity/{descriptorAlias}":{"get":{"operationId":"getDescriptorMetadata_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"descriptorAlias","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{context}/metadata/query":{"get":{"operationId":"getQueriesMetadata_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{context}/query/{name}":{"get":{"operationId":"namedQuery_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}},"post":{"operationId":"namedQueryUpdate_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{}}}}}},"/{context}/singleResultQuery/{name}":{"get":{"operationId":"namedQuerySingleResult_1","parameters":[{"name":"context","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/xml":{},"application/octet-stream":{}}}}}},"/app/accountCategories":{"get":{"tags":["AccountCategories"],"summary":"Resource to get an account category or a list of account categories. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"rate-id","in":"query","description":"Filter clause (examples -> 'rate-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, rate-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns account categories list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/accountCategories/6\",
\"deleted\": false,
\"rate-path\": null,
\"rate-id\": null,
\"name\": \"End Clients\",
\"description\": null,
\"id\": 6
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["AccountCategories"],"summary":"Resource to create a new account category","operationId":"doPost","requestBody":{"description":"Minimum body:
{
\"name\": \"John\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AccountCategoryPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/accountCategories/{ID}":{"get":{"tags":["AccountCategories"],"summary":"Resource to get an account category by ID.","operationId":"doGetById","parameters":[{"name":"ID","in":"path","description":"ID of account category","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an account category (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/accountCategories/6\",
\"deleted\": false,
\"rate-path\": null,
\"rate-id\": null,
\"name\": \"End Clients\",
\"description\": null,
\"id\": 6
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["AccountCategories"],"summary":"Resource to update an existing account category","operationId":"doPut","parameters":[{"name":"ID","in":"path","description":"ID of account category","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AccountCategoryPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["AccountCategories"],"summary":"Resource to delete an existing account category","operationId":"doDelete","parameters":[{"name":"ID","in":"path","description":"ID of account category","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/addresses":{"get":{"tags":["Addresses"],"summary":"Resource to get an address or a list of addresses. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_1","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"extra-data","in":"query","description":"Filter clause (examples -> 'extra-data=foo', 'extra-data=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"address-data","in":"query","description":"Filter clause (examples -> 'address-data=foo', 'address-data=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"postal-code","in":"query","description":"Filter clause (examples -> 'postal-code=foo', 'postal-code=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"province","in":"query","description":"Filter clause (examples -> 'province=foo', 'province=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"city-town","in":"query","description":"Filter clause (examples -> 'city-town=foo', 'city-town=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter clause (examples -> 'type=DEFAULT')
","schema":{"type":"string","enum":["DEFAULT","INVOICING","DELIVERY","OTHER"]}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,address-data:desc')
Sorting fields allowed: name, extra-data, address-data, postal-code, province, city-town, external-id, account-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns addresses list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"country-code\": \"US\",
\"city-town\": \"Perrysburg\",
\"account-id\": 94,
\"latitude\": null,
\"extra-data\": null,
\"account-path\": \"app.stelorder.com/app/clients/94\",
\"path\": \"app.stelorder.com/app/addresses/74\",
\"postal-code\": \"43551\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"province\": \"OH\",
\"name\": \"Default address\",
\"external-id\": null,
\"id\": 74,
\"address-data\": \"9087 Paris Hill Avenue \",
\"longitude\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Addresses"],"summary":"Resource to create a new address (Non DEFAULT Address)","operationId":"doPost_1","requestBody":{"description":"Minimum body:
{
\"account-id\": 123456,
\"address-data\": \"Address\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AddressPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/addresses/{ID}":{"get":{"tags":["Addresses"],"summary":"Resource to get an address by ID.","operationId":"doGetById_1","parameters":[{"name":"ID","in":"path","description":"ID of address","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an address (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"country-code\": \"US\",
\"city-town\": \"Perrysburg\",
\"account-id\": 94,
\"latitude\": null,
\"extra-data\": null,
\"account-path\": \"app.stelorder.com/app/clients/94\",
\"path\": \"app.stelorder.com/app/addresses/74\",
\"postal-code\": \"43551\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"province\": \"OH\",
\"name\": \"Default address\",
\"external-id\": null,
\"id\": 74,
\"address-data\": \"9087 Paris Hill Avenue \",
\"longitude\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Addresses"],"summary":"Resource to update an existing address (Non DEFAULT Address)","operationId":"doPut_1","parameters":[{"name":"ID","in":"path","description":"ID of address","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AddressPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Addresses"],"summary":"Resource to delete an existing address (Non DEFAULT Address)","operationId":"doDelete_1","parameters":[{"name":"ID","in":"path","description":"ID of address","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/assetImages":{"get":{"tags":["AssetImages"],"summary":"Resource to get an asset image or a list of asset images. The list is limited to 100 assets per request by default but can be increased to 500 using limit clause.","operationId":"doGet_2","parameters":[{"name":"order","in":"query","description":"Filter clause (examples -> 'order=0')
","schema":{"type":"integer","format":"int64"}},{"name":"asset-id","in":"query","description":"Filter clause (examples -> 'asset-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=order', 'sort=order:asc,asset-id:desc')
Sorting fields allowed: order, asset-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 assets)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns asset images list (if there are any result)
[{
\"path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxbw25Gi9f1clbaHKp7aAiwnW8s7M2ACrqO-moXEQYRoLDvosPmGYjJ7XeWzo0kIoKbddjtseVUL0LUcabwecjB0xwOOkHIjelM9sKf9xS49UOAuuLhNAUfbl_kLjfSYHJNKHIOUju9dcyf_4D4tSpryHk0WyYL-2fSbF7jylM7tdcnZIxUkXwbflaOYfp4zprhsuG7R\",
\"asset-path\": \"app.stelorder.com/app/assets/6852295\",
\"deleted\": false,
\"asset-id\": 6852295,
\"id\": 728729,
\"utc-last-modification-date\": \"2020-03-02T13:33:41+0000\",
\"order\": 0
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["AssetImages"],"summary":"Resource to upload an asset image","operationId":"doPost_2","requestBody":{"description":"Minimum body:
{
\"image-url\": \"https://storage.googleapis.com/storagestelordersite/64x64.png\",
\"asset-id\": 6852295,
\"order\": 0
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AssetImagePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/assetImages/{ID}":{"get":{"tags":["AssetImages"],"summary":"Resource to get an asset image by ID.","operationId":"doGetById_2","parameters":[{"name":"ID","in":"path","description":"ID of asset image","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an asset image (if there are any result)
[{
\"path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxbw25Gi9f1clbaHKp7aAiwnW8s7M2ACrqO-moXEQYRoLDvosPmGYjJ7XeWzo0kIoKbddjtseVUL0LUcabwecjB0xwOOkHIjelM9sKf9xS49UOAuuLhNAUfbl_kLjfSYHJNKHIOUju9dcyf_4D4tSpryHk0WyYL-2fSbF7jylM7tdcnZIxUkXwbflaOYfp4zprhsuG7R\",
\"asset-path\": \"app.stelorder.com/app/assets/6852295\",
\"deleted\": false,
\"asset-id\": 6852295,
\"id\": 728729,
\"utc-last-modification-date\": \"2020-03-02T13:33:41+0000\",
\"order\": 0
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["AssetImages"],"summary":"Resource to delete an existing asset image","operationId":"doDelete_2","parameters":[{"name":"ID","in":"path","description":"ID of asset image","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/assets":{"get":{"tags":["Assets"],"summary":"Resource to get an asset or a list of assets. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_3","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"Filter clause (examples -> 'identifier=foo', 'identifier=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number","in":"query","description":"Filter clause (examples -> 'serial-number=foo', 'serial-number=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"brand","in":"query","description":"Filter clause (examples -> 'brand=foo', 'brand=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"model","in":"query","description":"Filter clause (examples -> 'model=foo', 'model=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=account-id:asc,name:asc,reference:desc')
Sorting fields allowed: full-reference, reference, name, identifier, serial-number, brand, model, external-id, serial-number-id, account-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an assets list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"address-path\": \"app.stelorder.com/app/addresses/91\",
\"identifier\": null,
\"serial-number-id\": 12060,
\"serial-number\": null,
\"account-id\": 98,
\"description\": null,
\"warranty-start-date\": null,
\"warranty-end-date\": null,
\"account-path\": \"app.stelorder.com/app/potentialClients/98\",
\"reference\": \"00001\",
\"private-comments\": null,
\"deleted\": false,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/12060\",
\"name\": \"Demo Asset\",
\"model\": null,
\"asset-images\": [
{
\"asset-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"address-id\": 91,
\"id\": 147236,
\"full-reference\": \"AST00001\",
\"brand\": null,
\"subject-to-maintenance\": false
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Assets"],"summary":"Resource to create a new asset","operationId":"doPost_3","requestBody":{"description":"Minimum body:
{
\"name\": \"Professional kitchen assistant\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AssetPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/assets/{ID}":{"get":{"tags":["Assets"],"summary":"Resource to get an asset by ID.","operationId":"doGetById_3","parameters":[{"name":"ID","in":"path","description":"ID of asset","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an asset (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"address-path\": \"app.stelorder.com/app/addresses/91\",
\"identifier\": null,
\"serial-number-id\": 12060,
\"serial-number\": null,
\"account-id\": 98,
\"description\": null,
\"warranty-start-date\": null,
\"warranty-end-date\": null,
\"account-path\": \"app.stelorder.com/app/potentialClients/98\",
\"reference\": \"00001\",
\"private-comments\": null,
\"deleted\": false,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/12060\",
\"name\": \"Demo Asset\",
\"model\": null,
\"asset-images\": [
{
\"asset-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"address-id\": 91,
\"id\": 147236,
\"full-reference\": \"AST00001\",
\"brand\": null,
\"subject-to-maintenance\": false
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Assets"],"summary":"Resource to update an existing asset","operationId":"doPut_2","parameters":[{"name":"ID","in":"path","description":"ID of asset","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AssetPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Assets"],"summary":"Resource to delete an existing asset","operationId":"doDelete_3","parameters":[{"name":"ID","in":"path","description":"ID of asset","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/bankAccounts":{"get":{"tags":["BankAccounts"],"summary":"Resource to get a bank account or a list of bank account. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_4","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"bic-swift","in":"query","description":"Filter clause (examples -> 'bic-swift=foo', 'bic-swift=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"account","in":"query","description":"Filter clause (examples -> 'account=foo', 'account=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"default","in":"query","description":"Filter clause (examples -> 'default=true')
","schema":{"type":"boolean"}},{"name":"countable-account","in":"query","description":"Filter clause (examples -> 'countable-account=foo', 'countable-account=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, bic-swift, account, default, countable-account, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns bank accounts list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/bankAccounts/19\",
\"city-town\": \"Perrysburg\",
\"default\": false,
\"deleted\": false,
\"name\": \"CREDIT BANK\",
\"description\": null,
\"countable-account\": null,
\"id\": 19,
\"account\": \"ES0200302053020000875271\",
\"bic-swift\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["BankAccounts"],"summary":"Resource to create a new bank account","operationId":"doPost_4","requestBody":{"description":"Minimum body:
{
\"account\": \"Main Bank Account\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BankAccountPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/bankAccounts/{ID}":{"get":{"tags":["BankAccounts"],"summary":"Resource to get a bank account by ID.","operationId":"doGetById_4","parameters":[{"name":"ID","in":"path","description":"ID of bank account","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a bank account (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/bankAccounts/19\",
\"city-town\": \"Perrysburg\",
\"default\": false,
\"deleted\": false,
\"name\": \"CREDIT BANK\",
\"description\": null,
\"countable-account\": null,
\"id\": 19,
\"account\": \"ES0200302053020000875271\",
\"bic-swift\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["BankAccounts"],"summary":"Resource to update an existing bank account","operationId":"doPut_3","parameters":[{"name":"ID","in":"path","description":"ID of bank account","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BankAccountPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/calendars/{ID}":{"get":{"tags":["Calendars"],"summary":"Resource to get a calendar by ID.","operationId":"doGetById_5","parameters":[{"name":"ID","in":"path","description":"ID of calendar","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a calendar (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/calendars/17\",
\"deleted\": false,
\"name\": \"Calendar\",
\"description\": null,
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/calendars":{"get":{"tags":["Calendars"],"summary":"Resource to get a calendar or a list of calendars. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_5","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"owner-id","in":"query","description":"Filter clause (examples -> 'owner-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, owner-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns calendars list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/calendars/17\",
\"deleted\": false,
\"name\": \"Personal\",
\"description\": null,
\"id\": 17,
\"owner-id\": 1,
\"owner-path\": \"app.stelorder.com/app/employees/1\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/clients":{"get":{"tags":["Clients"],"summary":"Resource to get a client or a list of clients. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_6","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"legal-name","in":"query","description":"Filter clause (examples -> 'legal-name=foo', 'legal-name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"tax-identification-number","in":"query","description":"Filter clause (examples -> 'tax-identification-number=foo', 'tax-identification-number=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter clause (examples -> 'email=foo', 'email=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Filter clause (examples -> 'phone=612345678', 'phone=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"phone2","in":"query","description":"Filter clause (examples -> 'phone2=612345678', 'phone2=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"fax","in":"query","description":"Filter clause (examples -> 'fax=612345678', 'fax=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"invoice-to-account-id","in":"query","description":"Filter clause (examples -> 'invoice-to-account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-category-id","in":"query","description":"Filter clause (examples -> 'account-category-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"rate-id","in":"query","description":"Filter clause (examples -> 'rate-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=account-category-id:asc,name:asc,reference:desc')
Sorting fields allowed: full-reference, reference, legal-name, name, tax-identification-number, email, phone, phone2, fax, creation-date, external-id, serial-number-id, account-category-id, rate-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a clients list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"client-category-path\": \"app/clientCategories/5\",
\"phone2\": null,
\"payment-day\": null,
\"special-prices\": [
{
\"item-path\": \"app.stelorder.com/app/services/6852234\",
\"item-id\": 6852234,
\"price\": 6
},
{
\"item-path\": \"app.stelorder.com/app/products/6852296\",
\"item-id\": 6852296,
\"price\": 100
}
],
\"discount-percentage\": 0,
\"client-category-id\": 5,
\"identification-number\": \"B99999999\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"phone\": \"96666666\",
\"reference\": \"000002\",
\"path\": \"app/clients/68\",
\"primary-tax-enabled\": true,
\"serial-number-path\": \"app/serialNumbers/30\",
\"rate-path\": null,
\"legal-name\": \"Peter of the sticks\",
\"currency\": \"EUR\",
\"id\": 68,
\"fax\": null,
\"income-tax-enabled\": false,
\"email\": \"info@info.com\",
\"main-address\": {
\"country-code\": \"ES\",
\"address-type-name\": \"Default\",
\"city-town\": \"Toledo\",
\"extra-data\": null,
\"path\": \"app/addresses/55\",
\"account-path\": \"app/clients/68\",
\"account-id\": 68,
\"latitude\": 1.33,
\"longitude\": -2.55,
\"postal-code\": \"45004\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"province\": \"Toledo\",
\"name\": \"Default address\",
\"id\": 55,
\"formatted-address\": \"Paseo Cristo de la Vega, 12\",
\"address-data\": \"Paseo Cristo de la Vega, 12\"
},
\"bank-account\": {
\"deleted\": false,
\"account-id\": 68,
\"name\": null,
\"description\": null,
\"utc-last-modification-date\": \"2023-03-13T10:06:58+0000\",
\"account\": \"21218617\",
\"account-path\": \"app.stelorder.com/app/clients/68\",
\"bic-swift\": null
},
\"payment-terms-id\": null,
\"payment-terms-path\": null,
\"agent-id\": null,
\"website\": \"www.petersticks.com\",
\"serial-number-id\": 30,
\"invoice-to-account-id\": null,
\"invoice-to-account-path\": null,
\"comments\": null,
\"payment-option-id\": null,
\"countable-account\": null,
\"secondary-tax-enabled\": false,
\"payment-adjustment\": null,
\"agent-path\": null,
\"deleted\": false,
\"rate-id\": null,
\"name\": \"Peter sticks\",
\"creation-date\": \"2019-04-05T13:40:41+0000\",
\"currency-position\": \"RIGHT\",
\"payment-option-path\": null,
\"full-reference\": \"CLI000002\",
\"currency-code\": \"EUR\",
\"currency-symbol\": \"€\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Clients"],"summary":"Resource to create a new client","operationId":"doPost_5","requestBody":{"description":"Minimum body:
{
\"legal-name\": \"John\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClientPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/clients/{ID}":{"get":{"tags":["Clients"],"summary":"Resource to get a client by ID.","operationId":"doGetById_6","parameters":[{"name":"ID","in":"path","description":"ID of client","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a client (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"client-category-path\": \"app/clientCategories/5\",
\"phone2\": null,
\"payment-day\": null,
\"special-prices\": [
{
\"item-path\": \"app.stelorder.com/app/services/6852234\",
\"item-id\": 6852234,
\"price\": 6
},
{
\"item-path\": \"app.stelorder.com/app/products/6852296\",
\"item-id\": 6852296,
\"price\": 100
}
],
\"discount-percentage\": 0,
\"client-category-id\": 5,
\"identification-number\": \"B99999999\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"phone\": \"96666666\",
\"reference\": \"000002\",
\"path\": \"app/clients/68\",
\"primary-tax-enabled\": true,
\"serial-number-path\": \"app/serialNumbers/30\",
\"rate-path\": null,
\"legal-name\": \"Peter of the sticks\",
\"currency\": \"EUR\",
\"id\": 68,
\"fax\": null,
\"income-tax-enabled\": false,
\"email\": \"info@info.com\",
\"main-address\": {
\"country-code\": \"ES\",
\"address-type-name\": \"Default\",
\"city-town\": \"Toledo\",
\"extra-data\": null,
\"path\": \"app/addresses/55\",
\"account-path\": \"app/clients/68\",
\"account-id\": 68,
\"latitude\": 1.33,
\"longitude\": -2.55,
\"postal-code\": \"45004\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"province\": \"Toledo\",
\"name\": \"Default address\",
\"id\": 55,
\"formatted-address\": \"Paseo Cristo de la Vega, 12\",
\"address-data\": \"Paseo Cristo de la Vega, 12\"
},
\"bank-account\": {
\"deleted\": false,
\"account-id\": 68,
\"name\": null,
\"description\": null,
\"utc-last-modification-date\": \"2023-03-13T10:06:58+0000\",
\"account\": \"21218617\",
\"account-path\": \"app.stelorder.com/app/clients/68\",
\"bic-swift\": null
},
\"payment-terms-id\": null,
\"payment-terms-path\": null,
\"agent-id\": null,
\"website\": \"www.petersticks.com\",
\"serial-number-id\": 30,
\"comments\": null,
\"payment-option-id\": null,
\"countable-account\": null,
\"secondary-tax-enabled\": false,
\"payment-adjustment\": null,
\"agent-path\": null,
\"deleted\": false,
\"rate-id\": null,
\"name\": \"Peter sticks\",
\"creation-date\": \"2019-04-05T13:40:41+0000\",
\"currency-position\": \"RIGHT\",
\"payment-option-path\": null,
\"full-reference\": \"CLI000002\",
\"currency-code\": \"EUR\",
\"currency-symbol\": \"€\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Clients"],"summary":"Resource to update an existing client","operationId":"doPut_4","parameters":[{"name":"ID","in":"path","description":"ID of client","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClientPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Clients"],"summary":"Resource to delete an existing client","operationId":"doDelete_4","parameters":[{"name":"ID","in":"path","description":"ID of client","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/contacts":{"get":{"tags":["Contacts"],"summary":"Resource to get a contact or a list of contacts. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_7","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter clause (examples -> 'email=foo', 'email=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Filter clause (examples -> 'phone=foo', 'phone=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"fax","in":"query","description":"Filter clause (examples -> 'fax=foo', 'fax=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"position","in":"query","description":"Filter clause (examples -> 'position=foo', 'position=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,email:desc')
Sorting fields allowed: name, email, phone, fax, position, external-id, account-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns contacts list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/contacts/7\",
\"deleted\": false,
\"comments\": null,
\"phone\": \"+1 317-555-0166\",
\"account-id\": 90,
\"name\": \"Alice Moore\",
\"external-id\": null,
\"id\": 7,
\"position\": \"Assistant\",
\"fax\": null,
\"email\": \"alice.moore@exampleaddress.com\",
\"account-path\": \"app.stelorder.com/app/clients/90\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Contacts"],"summary":"Resource to create a new contact","operationId":"doPost_6","requestBody":{"description":"Minimum body:
{
\"name\": \"John\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ContactPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/contacts/{ID}":{"get":{"tags":["Contacts"],"summary":"Resource to get a contact by ID.","operationId":"doGetById_7","parameters":[{"name":"ID","in":"path","description":"ID of contact","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a contact (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/contacts/7\",
\"deleted\": false,
\"comments\": null,
\"phone\": \"+1 317-555-0166\",
\"account-id\": 90,
\"name\": \"Alice Moore\",
\"external-id\": null,
\"id\": 7,
\"position\": \"Assistant\",
\"fax\": null,
\"email\": \"alice.moore@exampleaddress.com\",
\"account-path\": \"app.stelorder.com/app/clients/90\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Contacts"],"summary":"Resource to update an existing contact","operationId":"doPut_5","parameters":[{"name":"ID","in":"path","description":"ID of contact","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ContactPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Contacts"],"summary":"Resource to delete an existing contact","operationId":"doDelete_5","parameters":[{"name":"ID","in":"path","description":"ID of contact","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/deliveryOptions":{"get":{"tags":["DeliveryOptions"],"summary":"Resource to get a delivery options or a list of delivery options. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_8","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns delivery options list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/deliveryOptions/1\",
\"deleted\": false,
\"name\": \"Standard Delivery\",
\"description\": \"A standard delivery\",
\"id\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["DeliveryOptions"],"summary":"Resource to create a new delivery option","operationId":"doPost_7","requestBody":{"description":"Minimum body:
{
\"name\": \"John\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/DeliveryOptionPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/deliveryOptions/{ID}":{"get":{"tags":["DeliveryOptions"],"summary":"Resource to get a delivery option by ID.","operationId":"doGetById_8","parameters":[{"name":"ID","in":"path","description":"ID of delivery option","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a delivery option (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/deliveryOptions/1\",
\"deleted\": false,
\"name\": \"Standard Delivery\",
\"description\": \"A standard delivery\",
\"id\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["DeliveryOptions"],"summary":"Resource to update an existing delivery option","operationId":"doPut_6","parameters":[{"name":"ID","in":"path","description":"ID of delivery option","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/DeliveryOptionPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["DeliveryOptions"],"summary":"Resource to delete an existing delivery option","operationId":"doDelete_6","parameters":[{"name":"ID","in":"path","description":"ID of delivery option","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/documentStates/{ID}":{"get":{"tags":["DocumentStates"],"summary":"Resource to get a document state by ID.","operationId":"doGetById_9","parameters":[{"name":"ID","in":"path","description":"ID of document state","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a document state (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/documentStates/77\",
\"deleted\": false,
\"color\": \"#ffeeb2\",
\"name\": \"Unpaid\",
\"description\": null,
\"id\": 77,
\"type\": \"PURCHASEINVOICE\",
\"order\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/documentStates":{"get":{"tags":["DocumentStates"],"summary":"Resource to get a document state or a list of document states. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_9","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"order","in":"query","description":"Filter clause (examples -> 'order=1')
","schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","description":"Filter clause (examples -> 'type=ORDINARYINVOICE')
","schema":{"type":"string","enum":["SALESESTIMATE","SALESORDER","SALESDELIVERYNOTE","WORKESTIMATE","WORKORDER","WORKDELIVERYNOTE","INCIDENT","ORDINARYINVOICE","REFUNDINVOICE","PURCHASEORDER","PURCHASEDELIVERYNOTE","PURCHASEINVOICE","INVOICERECEIPT","SUPPLIERRECEIPT","EXPENSE"]}},{"name":"color","in":"query","description":"Filter clause (examples -> 'color=foo', 'color=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, order, type, color, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns document states list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/documentStates/77\",
\"deleted\": false,
\"color\": \"#ffeeb2\",
\"name\": \"Unpaid\",
\"description\": null,
\"id\": 77,
\"type\": \"PURCHASEINVOICE\",
\"order\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/employeeRoles/{ID}":{"get":{"tags":["EmployeeRoles"],"summary":"Resource to get an employee role by ID.","operationId":"doGetById_10","parameters":[{"name":"ID","in":"path","description":"ID of employee role","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an employee role (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/employeeRoles/-2\",
\"deleted\": false,
\"name\": \"Super admin\",
\"creation-date\": \"2017-02-14T16:00:51+0000\",
\"id\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/employeeRoles":{"get":{"tags":["EmployeeRoles"],"summary":"Resource to get an employee role or a list of employees roles. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_10","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,utc-last-modification-date:desc')
Sorting fields allowed: name, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns employee role list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/employeeRoles/-2\",
\"deleted\": false,
\"name\": \"Super admin\",
\"creation-date\": \"2017-02-14T16:00:51+0000\",
\"id\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/employees/{ID}":{"get":{"tags":["Employees"],"summary":"Resource to get an employee by ID.","operationId":"doGetById_11","parameters":[{"name":"ID","in":"path","description":"ID of employee","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an employee (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"user-name\": \"user@stelorder.com\",
\"tax-identification-number\": null,
\"phone\": null,
\"name\": null,
\"surname\": null,
\"phone2\": null,
\"creation-date\": \"2017-02-14T16:00:51+0000\",
\"employee-role-id\": -2,
\"employee-role-path\": \"app.stelorder.com/app/employeeRoles/-2\",
\"id\": 1,
\"position\": null,
\"email\": \"user@stelorder.com\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/employees":{"get":{"tags":["Employees"],"summary":"Resource to get an employee or a list of employees. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_11","parameters":[{"name":"user-name","in":"query","description":"Filter clause (examples -> 'user-name=foo', 'user-name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"surname","in":"query","description":"Filter clause (examples -> 'surname=foo', 'surname=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"tax-identification-number","in":"query","description":"Filter clause (examples -> 'tax-identification-number=foo', 'tax-identification-number=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Filter clause (examples -> 'phone=foo', 'phone=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone2","in":"query","description":"Filter clause (examples -> 'phone2=foo', 'phone2=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter clause (examples -> 'email=foo', 'email=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"position","in":"query","description":"Filter clause (examples -> 'position=foo', 'position=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"employee-role-id","in":"query","description":"Filter clause (example -> 'employee-role-id=1')
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,email:desc')
Sorting fields allowed: user-name, name, surname, tax-identification-number, phone, phone2, email, position, creation-date, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns employee list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"user-name\": \"user@stelorder.com\",
\"tax-identification-number\": null,
\"phone\": null,
\"name\": null,
\"surname\": null,
\"phone2\": null,
\"creation-date\": \"2017-02-14T16:00:51+0000\",
\"employee-role-id\": -2,
\"employee-role-path\": \"app.stelorder.com/app/employeeRoles/-2\",
\"id\": 1,
\"position\": null,
\"email\": \"user@stelorder.com\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/entityAttachments":{"get":{"tags":["EntityAttachments"],"summary":"Resource to get a list of attachments (documents). The list is limited to 100 items per request by default.","operationId":"doGet_12","parameters":[{"name":"entity-id","in":"query","description":"Filter clause (examples -> 'entity-id=12345')
","schema":{"type":"integer","format":"int64"}},{"name":"entity-type","in":"query","description":"Filter clause (examples -> 'entity-type=WORKORDER')
","schema":{"type":"string","enum":["PRODUCT","SERVICE","EXPENSEANDINVESTMENT","ASSET","CLIENT","POTENTIALCLIENT","SUPPLIER","SALESESTIMATE","SALESORDER","SALESDELIVERYNOTE","INCIDENT","WORKESTIMATE","WORKORDER","WORKDELIVERYNOTE","ORDINARYINVOICE","REFUNDINVOICE","PURCHASEORDER","PURCHASEDELIVERYNOTE","PURCHASEINVOICE","EXPENSE","EVENT"]}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=invoice', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=order')
","schema":{"type":"string"}},{"name":"start-upload-date","in":"query","description":"Filter all attachments uploaded from start-upload-date (examples -> 'start-upload-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-upload-date","in":"query","description":"Filter all attachments uploaded until end-upload-date (examples -> 'end-upload-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=upload-date', 'sort=upload-date:desc,name:asc')
Sorting fields allowed: name, description, upload-date, utc-last-modification-date","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns documents list (if there are any result)
[{
\"id\": 550,
\"path\": \"app.stelorder.com/app/attachments/550\",
\"deleted\": false,
\"utc-last-modification-date\": \"2025-11-25T10:00:00+0000\",
\"name\": \"document.pdf\",
\"description\": \"Document uploaded via API\",
\"upload-date\": \"2025-11-25T09:30:00+0000\"
\"entity-type\": \"PRODUCT\",
\"entity-path\": \"app.stelorder.com/app/products/29410460\",
\"entity-id\": 29410460
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["EntityAttachments"],"summary":"Resource to upload and attach a file to an entity using a file URL","operationId":"doPost_8","requestBody":{"description":"Minimum body:
{
\"file-url\": \"https://storage.googleapis.com/storagestelordersite/documento.pdf\",
\"entity-id\": 12345,
\"entity-type\": \"WORKORDER\",
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EntityAttachmentsPost"}}},"required":true},"responses":{"200":{"description":"Returns created attachment data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/entityAttachments/{ID}/download":{"get":{"tags":["EntityAttachments"],"summary":"Download the binary content of a specific attachment","operationId":"doGetById_12","parameters":[{"name":"ID","in":"path","description":"ID of the file to download","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Binary file stream","content":{"application/octet-stream":{}}},"400":{"description":"Invalid ID format"},"404":{"description":"Document not found"}},"security":[{"APIKEY":[]}]}},"/app/errorCodes":{"get":{"tags":["ErrorCodes"],"summary":"Resource to get all the STEL Order API Error Codes.","operationId":"doGet_13","responses":{"200":{"description":"Returns error codes
[{
\"error-code\": \"E000001\",
\"description\": \"Calls per minute limit exceeded\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/eventTypes":{"get":{"tags":["EventTypes"],"summary":"Resource to get an event type or a list of event types. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_14","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"color","in":"query","description":"Filter clause (examples -> 'color=foo', 'color=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,color:desc')
Sorting fields allowed: name, color, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns event types list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/eventTypes/17\",
\"deleted\": false,
\"name\": \"Call\",
\"color\": \"#FAFAFA\",
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["EventTypes"],"summary":"Resource to create a new event type","operationId":"doPost_9","requestBody":{"description":"Minimum body:
{
\"name\": \"name event type\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventTypePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/eventTypes/{ID}":{"get":{"tags":["EventTypes"],"summary":"Resource to get an event type by ID.","operationId":"doGetById_13","parameters":[{"name":"ID","in":"path","description":"ID of event type","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an event type (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/eventTypes/17\",
\"deleted\": false,
\"name\": \"Call\",
\"color\": \"#FAFAFA\",
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["EventTypes"],"summary":"Resource to update an existing event type","operationId":"doPut_7","parameters":[{"name":"ID","in":"path","description":"ID of event type","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventTypePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["EventTypes"],"summary":"Resource to delete an existing event type","operationId":"doDelete_7","parameters":[{"name":"ID","in":"path","description":"ID of event type","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/events":{"get":{"tags":["Events"],"summary":"Resource to get an event or a list of events. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_15","parameters":[{"name":"subject","in":"query","description":"Filter clause (examples -> 'subject=foo', 'subject=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"location","in":"query","description":"Filter clause (examples -> 'location=foo', 'location=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"start-date","in":"query","description":"Filter all events from the start-date (examples -> 'start-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all events until the end-date (examples -> 'end-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"all-day","in":"query","description":"Filter clause (examples -> 'all-day=true')
","schema":{"type":"boolean"}},{"name":"event-state","in":"query","description":"Filter clause (examples -> 'event-state=PENDING')
","schema":{"type":"string","enum":["PENDING","COMPLETED","REFUSED"]}},{"name":"calendar-id","in":"query","description":"Filter clause (examples -> 'calendar-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"event-type-id","in":"query","description":"Filter clause (examples -> 'event-type-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"asset-id","in":"query","description":"Filter clause (examples -> 'asset-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"incident-id","in":"query","description":"Filter clause (examples -> 'incident-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-id","in":"query","description":"Filter clause (examples -> 'document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=subject', 'sort=subject:asc,description:desc')
Sorting fields allowed: subject, description, location, start-date, end-date, all-day, calendar-id, event-type-id, creator-id, account-id, asset-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns events list (if there are any result)
[{
\"event-type-id\": null,
\"incident-path\": null,
\"subject\": \"A2\",
\"description\": null,
\"start-date\": \"2020-08-25T00:00:00+0000\",
\"utc-last-modification-date\": \"2020-08-25T10:56:00+0000\",
\"asset-path\": null,
\"incident-id\": null,
\"account-path\": null,
\"path\": \"app.stelorder.com/app/events/9018002\",
\"calendar-id\": 34722,
\"calendar-path\": \"app.stelorder.com/app/calendars/34722\",
\"asset-id\": null,
\"id\": 9018002,
\"event-state\": \"PENDING\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"account-id\": null,
\"document-path\": null,
\"creator-id\": 1,
\"event-type-path\": null,
\"end-date\": \"2020-08-25T00:00:00+0000\",
\"deleted\": false,
\"location\": null,
\"all-day\": true,
\"document-id\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Events"],"summary":"Resource to create a new event","operationId":"doPost_10","requestBody":{"description":"Minimum body:
{
\"start-date\": \"2023-07-20T00:00:00+0000\",
\"end-date\": \"2023-07-21T00:00:00+0000\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/events/{ID}":{"get":{"tags":["Events"],"summary":"Resource to get an event by ID.","operationId":"doGetById_14","parameters":[{"name":"ID","in":"path","description":"ID of event","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an event (if there are any result)
[{
\"event-type-id\": null,
\"incident-path\": null,
\"subject\": \"A2\",
\"description\": null,
\"start-date\": \"2020-08-25T00:00:00+0000\",
\"utc-last-modification-date\": \"2020-08-25T10:56:00+0000\",
\"asset-path\": null,
\"incident-id\": null,
\"account-path\": null,
\"path\": \"app.stelorder.com/app/events/9018002\",
\"calendar-id\": 34722,
\"calendar-path\": \"app.stelorder.com/app/calendars/34722\",
\"asset-id\": null,
\"id\": 9018002,
\"event-state\": \"PENDING\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"account-id\": null,
\"document-path\": null,
\"creator-id\": 1,
\"event-type-path\": null,
\"end-date\": \"2020-08-25T00:00:00+0000\",
\"deleted\": false,
\"location\": null,
\"all-day\": true,
\"document-id\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Events"],"summary":"Resource to update an existing event","operationId":"doPut_8","parameters":[{"name":"ID","in":"path","description":"ID of event","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Events"],"summary":"Resource to delete an existing event","operationId":"doDelete_8","parameters":[{"name":"ID","in":"path","description":"ID of event","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expenseCategories/{ID}":{"get":{"tags":["ExpenseCategories"],"summary":"Resource to get an expense category by ID.","operationId":"doGetById_15","parameters":[{"name":"ID","in":"path","description":"ID of expense category","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an expense category (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/productCategories/1\",
\"deleted\": false,
\"name\": \"Transport Expenses\",
\"id\": 1,
\"type\": \"EXPENSE\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expenseCategories":{"get":{"tags":["ExpenseCategories"],"summary":"Resource to get an expense category or a list of expense categories. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_16","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter clause (examples -> 'type=EXPENSE')
","schema":{"type":"string","enum":["EXPENSE","INVESTMENT"]}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc')
Sorting fields allowed: name, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns expense categories list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/productCategories/1\",
\"deleted\": false,
\"name\": \"Transport Expenses\",
\"id\": 1,
\"type\": \"EXPENSE\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expenseStates/{ID}":{"get":{"tags":["ExpenseStates"],"summary":"Resource to get an expense state by ID.","operationId":"doGetById_16","parameters":[{"name":"ID","in":"path","description":"ID of expense state","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an expense state (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/expenseStates/77\",
\"deleted\": false,
\"color\": \"#ffeeb2\",
\"name\": \"Unpaid\",
\"description\": null,
\"id\": 77,
\"order\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expenseStates":{"get":{"tags":["ExpenseStates"],"summary":"Resource to get an expense state or a list of expense states. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_17","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"order","in":"query","description":"Filter clause (examples -> 'order=1')
","schema":{"type":"integer","format":"int64"}},{"name":"color","in":"query","description":"Filter clause (examples -> 'color=foo', 'color=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed:
name, description, order, color, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns expense states list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/expenseStates/77\",
\"deleted\": false,
\"color\": \"#ffeeb2\",
\"name\": \"Unpaid\",
\"description\": null,
\"id\": 77,
\"order\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expenses":{"get":{"tags":["Expenses"],"summary":"Resource to get an Expense or a list of Expenses. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_18","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all expenses from the date (examples -> 'start-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all expenses until the date (examples -> 'end-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"payment-date","in":"query","description":"Filter clause (examples -> 'payment-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-payment-date","in":"query","description":"Filter all expenses from the payment-date (examples -> 'start-payment-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-payment-date","in":"query","description":"Filter all expenses until the payment-date (examples -> 'end-payment-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"amount","in":"query","description":"Filter clause (examples -> 'amount=30)
","schema":{"type":"number","format":"double"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"countable-account","in":"query","description":"Filter clause (examples -> 'countable-account=foo', 'countable-account=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"settled","in":"query","description":"Filter clause (examples -> 'settled=true)'
","schema":{"type":"boolean"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"expense-category-id","in":"query","description":"Filter clause (examples -> 'expense-category-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"payment-option-id","in":"query","description":"Filter clause (examples -> 'payment-option-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"bank-account-id","in":"query","description":"Filter clause (examples -> 'bank-account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"expense-state-id","in":"query","description":"Filter clause (examples -> 'expense-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"employee-id","in":"query","description":"Filter clause (examples -> 'employee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"paid-employee-id","in":"query","description":"Filter clause (examples -> 'paid-employee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified expenses from the date in UTC (examples -> 'utc-last-modification-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: full-reference, reference, date, payment-date, amount, description, countable-account, settled, serial-number-id, account-id, expense-category-id, payment-option-id, bank-account-id, expense-state-id, employee-id, paid-employee-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns expenses list (if there are any result)
[{
\"date\": \"2022-12-28T00:00:00+0000\",
\"bank-account-id\": null,
\"description\": null,
\"utc-last-modification-date\": \"2022-12-28T08:23:14+0000\",
\"payment-date\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/7876669\",
\"reference\": \"00001\",
\"expense-category-path\": \"app.stelorder.com/app/expenseCategories/1\",
\"path\": \"app.stelorder.com/app/expenses/476104\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/432214\",
\"paid-employee-id\": null,
\"expense-state-path\": \"app.stelorder.com/app/expenseStates/842619\",
\"id\": 476104,
\"expense-category-id\": 1,
\"employee-id\": 1,
\"serial-number-id\": 432214,
\"amount\": 0,
\"payment-option-id\": null,
\"account-id\": 7876669,
\"settled\": false,
\"countable-account\": null,
\"bank-account-path\": null,
\"expense-state-id\": 842619,
\"paid-employee-path\": null,
\"employee-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"payment-option-path\": null,
\"full-reference\": \"EXP00001\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Expenses"],"summary":"Resource to create a new expense","operationId":"doPost_11","requestBody":{"description":"Minimum body:
{
\"expense-category-id\": 1,
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ExpensePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expenses/{ID}":{"get":{"tags":["Expenses"],"summary":"Resource to get an Expense by ID.","operationId":"doGetById_17","parameters":[{"name":"ID","in":"path","description":"ID of expenses","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an expenses (if there are any result)
[{
\"date\": \"2022-12-28T00:00:00+0000\",
\"bank-account-id\": null,
\"description\": null,
\"utc-last-modification-date\": \"2022-12-28T08:23:14+0000\",
\"payment-date\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/7876669\",
\"reference\": \"00001\",
\"expense-category-path\": \"app.stelorder.com/app/expenseCategories/1\",
\"path\": \"app.stelorder.com/app/expenses/476104\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/432214\",
\"paid-employee-id\": null,
\"expense-state-path\": \"app.stelorder.com/app/expenseStates/842619\",
\"id\": 476104,
\"expense-category-id\": 1,
\"employee-id\": 1,
\"serial-number-id\": 432214,
\"amount\": 0,
\"payment-option-id\": null,
\"account-id\": 7876669,
\"settled\": false,
\"countable-account\": null,
\"bank-account-path\": null,
\"expense-state-id\": 842619,
\"paid-employee-path\": null,
\"employee-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"payment-option-path\": null,
\"full-reference\": \"EXP00001\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Expenses"],"summary":"Resource to update an existing expense","operationId":"doPut_9","parameters":[{"name":"ID","in":"path","description":"ID of expense","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ExpensePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Expenses"],"summary":"Resource to delete an existing expense","operationId":"doDelete_9","parameters":[{"name":"ID","in":"path","description":"ID of expense","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expensesAndInvestments":{"get":{"tags":["ExpensesAndInvestments"],"summary":"Resource to get an expense or investment or a list of expenses and investments. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_19","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter clause (examples -> 'type=EXPENSE')
","schema":{"type":"string","enum":["EXPENSE","INVESTMENT"]}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"private-comments","in":"query","description":"Filter clause (examples -> 'private-comments=foo', 'private-comments=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"expense-category-id","in":"query","description":"Filter clause (examples -> 'expense-category-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=expense-category-id:asc,name:asc,reference:desc')
Sorting fields allowed: full-reference, reference, name, description, private-comments, creation-date, external-id, serial-number-id, expense-category-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an expense or investment list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"expense-category-id\": 12,
\"primary-tax-percentage\": 10,
\"serial-number-id\": 63,
\"description\": null,
\"type\": \"EXPENSE\",
\"reference\": \"00001\",
\"expense-category-path\": \"app.stelorder.com/app/expenseCategories/12\",
\"path\": \"app.stelorder.com/app/expensesAndInvestments/85\",
\"private-comments\": null,
\"deleted\": false,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/63\",
\"secondary-tax-percentage\": 0,
\"item-images\": [
{
\"item-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/37273\",
\"name\": \"John's Salary\",
\"external-id\": null,
\"creation-date\": \"2017-05-30T01:31:47+0000\",
\"purchase-countable-account\": null,
\"primary-tax-id\": 37273,
\"id\": 85,
\"full-reference\": \"EAI00001\",
\"purchase-price\": 1300
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["ExpensesAndInvestments"],"summary":"Resource to create a new new expense or investment","operationId":"doPost_12","requestBody":{"description":"Minimum body:
{
\"name\": \"John's Salary\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ExpenseAndInvestmentPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/expensesAndInvestments/{ID}":{"get":{"tags":["ExpensesAndInvestments"],"summary":"Resource to get an expense or investment by ID.","operationId":"doGetById_18","parameters":[{"name":"ID","in":"path","description":"ID of expense or investment","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an expense or investment (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"expense-category-id\": 12,
\"primary-tax-percentage\": 10,
\"serial-number-id\": 63,
\"description\": null,
\"type\": \"EXPENSE\",
\"reference\": \"00001\",
\"expense-category-path\": \"app.stelorder.com/app/expenseCategories/12\",
\"path\": \"app.stelorder.com/app/expensesAndInvestments/85\",
\"private-comments\": null,
\"deleted\": false,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/63\",
\"secondary-tax-percentage\": 0,
\"item-images\": [
{
\"item-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/37273\",
\"name\": \"John's Salary\",
\"external-id\": null,
\"creation-date\": \"2017-05-30T01:31:47+0000\",
\"purchase-countable-account\": null,
\"primary-tax-id\": 37273,
\"id\": 85,
\"full-reference\": \"EAI00001\",
\"purchase-price\": 1300
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["ExpensesAndInvestments"],"summary":"Resource to update an existing expense or investment","operationId":"doPut_10","parameters":[{"name":"ID","in":"path","description":"ID of expense or investment","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ExpenseAndInvestmentPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["ExpensesAndInvestments"],"summary":"Resource to delete an existing expense or investment","operationId":"doDelete_10","parameters":[{"name":"ID","in":"path","description":"ID of expense or investment","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/incidentStates/{ID}":{"get":{"tags":["IncidentStates"],"summary":"Resource to get an incident state by ID.","operationId":"doGetById_19","parameters":[{"name":"ID","in":"path","description":"ID of incident state","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an incident state (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/incidentStates/77\",
\"deleted\": false,
\"color\": \"#ffeeb2\",
\"name\": \"Unpaid\",
\"description\": null,
\"id\": 77,
\"order\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/incidentStates":{"get":{"tags":["IncidentStates"],"summary":"Resource to get an incident state or a list of incident states. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_20","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"order","in":"query","description":"Filter clause (examples -> 'order=1')
","schema":{"type":"integer","format":"int64"}},{"name":"color","in":"query","description":"Filter clause (examples -> 'color=foo', 'color=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed:
name, description, order, color, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns incident states list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/incidentStates/77\",
\"deleted\": false,
\"color\": \"#ffeeb2\",
\"name\": \"Unpaid\",
\"description\": null,
\"id\": 77,
\"order\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/incidentTypes":{"get":{"tags":["IncidentTypes"],"summary":"Resource to get an incident type or a list of incident types. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_21","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"color","in":"query","description":"Filter clause (examples -> 'color=foo', 'color=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,color:desc')
Sorting fields allowed: name, color, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns incident types list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/incidentTypes/17\",
\"deleted\": false,
\"name\": \"Call\",
\"color\": \"#FAFAFA\",
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["IncidentTypes"],"summary":"Resource to create a new incident type","operationId":"doPost_13","requestBody":{"description":"Minimum body:
{
\"name\": \"name incident type\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/IncidentTypePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/incidentTypes/{ID}":{"get":{"tags":["IncidentTypes"],"summary":"Resource to get an incident type by ID.","operationId":"doGetById_20","parameters":[{"name":"ID","in":"path","description":"ID of incident type","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an incident type (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/incidentTypes/17\",
\"deleted\": false,
\"name\": \"Call\",
\"color\": \"#FAFAFA\",
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["IncidentTypes"],"summary":"Resource to update an existing incident type","operationId":"doPut_11","parameters":[{"name":"ID","in":"path","description":"ID of incident type","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/IncidentTypePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["IncidentTypes"],"summary":"Resource to delete an existing incident type","operationId":"doDelete_11","parameters":[{"name":"ID","in":"path","description":"ID of incident type","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/incidents":{"get":{"tags":["Incidents"],"summary":"Resource to get an incident or a list of incidents. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_22","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"priority","in":"query","description":"Filter clause (examples -> 'priority=NORMAL')
","schema":{"type":"string","enum":["VERYLOW","LOW","NORMAL","HIGH","VERYHIGH"]}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all incidents from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all incidents until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"closing-date","in":"query","description":"Filter clause (examples -> 'closing-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-closing-date","in":"query","description":"Filter all incidents from closing-date (examples -> 'start-closing-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-closing-date","in":"query","description":"Filter all incidents until closing-date (examples -> 'end-closing-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"phone","in":"query","description":"Filter clause (examples -> 'phone=foo', 'phone=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"length","in":"query","description":"Filter clause (examples -> 'length=0')
","schema":{"type":"integer","format":"int64"}},{"name":"resolution","in":"query","description":"Filter clause (examples -> 'resolution=foo', 'resolution=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"assignee-id","in":"query","description":"Filter clause (examples -> 'assignee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"incident-state-id","in":"query","description":"Filter clause (examples -> 'incident-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"incident-type-id","in":"query","description":"Filter clause (examples -> 'incident-type-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified incidents from the date in UTC (examples -> 'utc-last-modification-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=account-id:asc,description:asc,reference:desc')
Sorting fields allowed: full-reference, reference, description, date, priority, phone, length, resolution, external-id, serial-number-id, account-id, creator-id, assignee-id, incident-state-id, incident-type-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an incidents list (if there are any result)
[{
\"utc-last-modification-date\": \"2025-01-21T10:44:19+0000\",
\"creation-date\": \"2016-11-28T16:58:37+0000\",
\"state-changed-date\": \"2016-11-28T16:58:37+0000\",
\"date\": \"2016-11-28T18:08:00+0000\",
\"invoice-to-account-id\": null,
\"incident-state-path\": \"app.stelorder.com/app/incidentStates/97\",
\"assignee-path\": \"app.stelorder.com/app/employees/1\",
\"description\": \"TV Repairs\",
\"phone\": null,
\"length\": 0,
\"resolution\": null,
\"incident-type-id\": 977,
\"assignee-id\": 1,
\"account-path\": \"app.stelorder.com/app/clients/80\",
\"reference\": \"00001\",
\"path\": \"app.stelorder.com/app/incidents/5\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/61\",
\"assets\": [
{
\"path\": \"app.stelorder.com/app/assets/147236\",
\"id\": 147236,
\"order\": 0
}
],
\"external-id\": null,
\"id\": 5,
\"address-path\": \"app.stelorder.com/app/addresses/76\",
\"serial-number-id\": 61,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"account-id\": 80,
\"incident-state-id\": 97,
\"creator-id\": 1,
\"priority\": \"HIGH\",
\"invoice-to-account-path\": null,
\"deleted\": false,
\"assigned-date\": \"2016-11-28T18:08:00+0000\",
\"address-id\": 76,
\"full-reference\": \"INC00001\",
\"creation-notification\": true,
\"closed-notification\": true,
\"closing-date\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Incidents"],"summary":"Resource to create a new incident","operationId":"doPost_14","requestBody":{"description":"Minimum body:
{
\"description\": \"Description\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/IncidentPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/incidents/{ID}":{"get":{"tags":["Incidents"],"summary":"Resource to get an incident by ID.","operationId":"doGetById_21","parameters":[{"name":"ID","in":"path","description":"ID of incident","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an incident (if there are any result)
[{
\"utc-last-modification-date\": \"2025-01-21T10:44:19+0000\",
\"creation-date\": \"2016-11-28T16:58:37+0000\",
\"state-changed-date\": \"2016-11-28T16:58:37+0000\",
\"date\": \"2016-11-28T18:08:00+0000\",
\"invoice-to-account-id\": null,
\"incident-state-path\": \"app.stelorder.com/app/incidentStates/97\",
\"assignee-path\": \"app.stelorder.com/app/employees/1\",
\"description\": \"TV Repairs\",
\"phone\": null,
\"length\": 0,
\"resolution\": null,
\"incident-type-id\": 977,
\"assignee-id\": 1,
\"account-path\": \"app.stelorder.com/app/clients/80\",
\"reference\": \"00001\",
\"path\": \"app.stelorder.com/app/incidents/5\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/61\",
\"assets\": [
{
\"path\": \"app.stelorder.com/app/assets/147236\",
\"id\": 147236,
\"order\": 0
}
],
\"external-id\": null,
\"id\": 5,
\"address-path\": \"app.stelorder.com/app/addresses/76\",
\"serial-number-id\": 61,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"account-id\": 80,
\"incident-state-id\": 97,
\"creator-id\": 1,
\"priority\": \"HIGH\",
\"invoice-to-account-path\": null,
\"deleted\": false,
\"assigned-date\": \"2016-11-28T18:08:00+0000\",
\"address-id\": 76,
\"full-reference\": \"INC00001\",
\"creation-notification\": true,
\"closed-notification\": true,
\"closing-date\": null
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Incidents"],"summary":"Resource to update an existing incident","operationId":"doPut_12","parameters":[{"name":"ID","in":"path","description":"ID of incident","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/IncidentPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Incidents"],"summary":"Resource to delete an existing incident","operationId":"doDelete_12","parameters":[{"name":"ID","in":"path","description":"ID of incident","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/issueInvoiceVerifactu/{ID}":{"post":{"tags":["IssueInvoiceVerifactu"],"summary":"Resource to issue an existing Ordinary or Refund Invoice","operationId":"doPost_15","parameters":[{"name":"ID","in":"path","description":"ID of Ordinary or Refund Invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Minimum body:
{
\"paid\": false
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/IssueInvoiceVerifactuPost"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/itemImages":{"get":{"tags":["ItemImages"],"summary":"Resource to get an item image or a list of item images. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_23","parameters":[{"name":"order","in":"query","description":"Filter clause (examples -> 'order=0')
","schema":{"type":"integer","format":"int64"}},{"name":"item-id","in":"query","description":"Filter clause (examples -> 'item-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=order', 'sort=order:asc,item-id:desc')
Sorting fields allowed: order, item-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns item images list (if there are any result)
[{
\"path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxbw25Gi9f1clbaHKp7aAiwnW8s7M2ACrqO-moXEQYRoLDvosPmGYjJ7XeWzo0kIoKbddjtseVUL0LUcabwecjB0xwOOkHIjelM9sKf9xS49UOAuuLhNAUfbl_kLjfSYHJNKHIOUju9dcyf_4D4tSpryHk0WyYL-2fSbF7jylM7tdcnZIxUkXwbflaOYfp4zprhsuG7R\",
\"item-path\": \"app.stelorder.com/app/products/6852295\",
\"deleted\": false,
\"item-id\": 6852295,
\"id\": 728729,
\"utc-last-modification-date\": \"2020-03-02T13:33:41+0000\",
\"order\": 0
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["ItemImages"],"summary":"Resource to upload an item image","operationId":"doPost_16","requestBody":{"description":"Minimum body:
{
\"image-url\": \"https://storage.googleapis.com/storagestelordersite/64x64.png\",
\"item-id\": 6852295,
\"order\": 0
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ItemImagePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/itemImages/{ID}":{"get":{"tags":["ItemImages"],"summary":"Resource to get an item image by ID.","operationId":"doGetById_22","parameters":[{"name":"ID","in":"path","description":"ID of item image","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an item image (if there are any result)
[{
\"path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxbw25Gi9f1clbaHKp7aAiwnW8s7M2ACrqO-moXEQYRoLDvosPmGYjJ7XeWzo0kIoKbddjtseVUL0LUcabwecjB0xwOOkHIjelM9sKf9xS49UOAuuLhNAUfbl_kLjfSYHJNKHIOUju9dcyf_4D4tSpryHk0WyYL-2fSbF7jylM7tdcnZIxUkXwbflaOYfp4zprhsuG7R\",
\"item-path\": \"app.stelorder.com/app/products/6852295\",
\"deleted\": false,
\"item-id\": 6852295,
\"id\": 728729,
\"utc-last-modification-date\": \"2020-03-02T13:33:41+0000\",
\"order\": 0
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["ItemImages"],"summary":"Resource to delete an existing item image","operationId":"doDelete_13","parameters":[{"name":"ID","in":"path","description":"ID of item image","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/itemRates":{"get":{"tags":["ItemRates"],"summary":"Resource to get an item rate or a list of item rates. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_24","parameters":[{"name":"item-id","in":"query","description":"Filter clause (examples -> 'item-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"rate-id","in":"query","description":"Filter clause (examples -> 'rate-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=price', 'sort=price:asc,item-id:desc')
Sorting fields allowed: item-id, rate-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an item rates items list (if there are any result)
[{
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["ItemRates"],"summary":"Resource to update an existing item rate","operationId":"doPut_13","requestBody":{"description":"Minimum body:
{
\"item-id\": 6852295,
\"rate-id\": 2414,
\"price\": 0
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ItemRatePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/ordinaryInvoiceReceipts/{ID}":{"get":{"tags":["OrdinaryInvoiceReceipts"],"summary":"Resource to get an ordinary invoice receipt by ID.","operationId":"doGetById_23","parameters":[{"name":"ID","in":"path","description":"ID of ordinary invoice receipt","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an ordinary invoice receipt (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"concept\": null,
\"currency-rate\": 1,
\"bank-account-id\": null,
\"payment-date\": \"2016-12-19T00:00:00+0000\",
\"account-path\": \"app.stelorder.com/app/clients/92\",
\"path\": \"app.stelorder.com/app/ordinaryInvoiceReceipts/21\",
\"original-element-id\": 22,
\"paid-employee-id\": null,
\"id\": 21,
\"creator-id\": 1,
\"amount\": 169.2,
\"payment-option-id\": 11,
\"account-id\": 92,
\"settled\": false,
\"bank-account-path\": null,
\"paid-employee-path\": \"app.stelorder.com/app/employees/1\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"original-element-path\": \"app.stelorder.com/app/ordinaryInvoices/22\",
\"sepa-generated\": false,
\"paid\": true,
\"payment-term-date\": \"2016-11-02T00:00:00+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"full-reference\": \"INV00005\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["OrdinaryInvoiceReceipts"],"summary":"Resource to update an existing ordinary invoice receipt","operationId":"doPut_14","parameters":[{"name":"ID","in":"path","description":"ID of ordinary invoice receipt","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/OrdinaryInvoiceReceiptPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/ordinaryInvoiceReceipts":{"get":{"tags":["OrdinaryInvoiceReceipts"],"summary":"Resource to get an ordinary invoice receipt or a list of ordinary invoice receipts. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_25","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"concept","in":"query","description":"Filter clause (examples -> 'concept=foo', 'concept=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"amount","in":"query","description":"Filter clause (examples -> 'amount=30)
","schema":{"type":"number","format":"double"}},{"name":"paid","in":"query","description":"Filter clause (examples -> 'paid=true)'
","schema":{"type":"boolean"}},{"name":"payment-term-date","in":"query","description":"Filter clause (examples -> 'payment-term-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-payment-term-date","in":"query","description":"Filter all ordinary invoice receipts frompayment-term-date (examples -> start-payment-term-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-payment-term-date","in":"query","description":"Filter all ordinary invoice receipts untilpayment-term-date (examples -> end-payment-term-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"payment-date","in":"query","description":"Filter clause (examples -> 'payment-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-payment-date","in":"query","description":"Filter all ordinary invoice receipts frompayment-date (examples -> start-payment-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-payment-date","in":"query","description":"Filter all ordinary invoice receipts untilpayment-date (examples -> 'end-payment-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sepa-generated","in":"query","description":"Filter clause (examples -> 'sepa-generated=true)'
","schema":{"type":"boolean"}},{"name":"settled","in":"query","description":"Filter clause (examples -> 'settled=true)'
","schema":{"type":"boolean"}},{"name":"original-element-id","in":"query","description":"Filter clause (examples -> 'original-element-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"paid-employee-id","in":"query","description":"Filter clause (examples -> 'paid-employee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"payment-option-id","in":"query","description":"Filter clause (examples -> 'payment-option-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"bank-account-id","in":"query","description":"Filter clause (examples -> 'bank-account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=concept', 'sort=concept:asc,full-reference:desc')
Sorting fields allowed: full-reference, concept, amount, paid, payment-term-date, payment-date, sepa-generated, settled, original-element-id, account-id, creator-id, paid-employee-id, payment-option-id, bank-account-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns ordinary invoice receipts list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"concept\": null,
\"currency-rate\": 1,
\"bank-account-id\": null,
\"payment-date\": \"2016-12-19T00:00:00+0000\",
\"account-path\": \"app.stelorder.com/app/clients/92\",
\"path\": \"app.stelorder.com/app/ordinaryInvoiceReceipts/21\",
\"original-element-id\": 22,
\"paid-employee-id\": null,
\"id\": 21,
\"creator-id\": 1,
\"amount\": 169.2,
\"payment-option-id\": 11,
\"account-id\": 92,
\"settled\": false,
\"bank-account-path\": null,
\"paid-employee-path\": \"app.stelorder.com/app/employees/1\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"original-element-path\": \"app.stelorder.com/app/ordinaryInvoices/22\",
\"sepa-generated\": false,
\"paid\": true,
\"payment-term-date\": \"2016-11-02T00:00:00+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"full-reference\": \"INV00005\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/ordinaryInvoices":{"get":{"tags":["OrdinaryInvoices"],"summary":"Resource to get an ordinary invoice or a list of ordinary invoices. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_26","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all ordinary invoices from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all ordinary invoices until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Returns an ordinary invoices list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/95\",
\"discount-percentage\": 0,
\"total-amount\": 91.86,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/87\",
\"path\": \"app.stelorder.com/app/ordinaryInvoices/60\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/56\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/salesDeliveryNotes/59\",
\"addendum\": null,
\"id\": 60,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 86,
\"document-state-id\": 87,
\"serial-number-id\": 56,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 14,
\"account-id\": 95,
\"settled\": false,
\"parent-document-id\": 59,
\"signed\": false,
\"tax-total-amount\": 15.31,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"paid-total-amount\": 91.86,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"creation-date\": \"2016-11-28T16:58:37+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/14\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 76.55,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 15.31
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/86\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/60\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 24.2,
\"deleted\": false,
\"item-id\": 60,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Spice Variety\",
\"item-deleted\": false,
\"item-description\": \"Multiple spices imported from India.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 246,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 12.1
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/73\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 10,
\"deleted\": false,
\"item-id\": 73,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Local Transport Service Costs\",
\"item-deleted\": false,
\"item-description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 247,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 10
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/67\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 5,
\"discount-percentage\": 0,
\"total-amount\": 42.35,
\"deleted\": false,
\"item-id\": 67,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Rose Cupcakes (5 units)\",
\"item-deleted\": false,
\"item-description\": \"Chocolate and vanilla cream filled cupcakes. Decorated with edible roses.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 245,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 8.47
}
],
\"sent-date\": null,
\"payment-terms-id\": 1,
\"payment-terms-path\": \"app.stelorder.com/app/paymentTerms/1\",
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 76.55,
\"delivery-option-path\": null,
\"remaining-total-amount\": 0,
\"signature-name\": null,
\"parent-incident-path\": null,
\"receipts\": [
{
\"path\": \"app.stelorder.com/app/ordinaryInvoiceReceipts/31\",
\"id\": 31
}],
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"INV00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["OrdinaryInvoices"],"summary":"Resource to create a new ordinary invoice","operationId":"doPost_17","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/OrdinaryInvoicePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/ordinaryInvoices/{ID}":{"get":{"tags":["OrdinaryInvoices"],"summary":"Resource to get an ordinary invoice by ID.","operationId":"doGetById_24","parameters":[{"name":"ID","in":"path","description":"ID of ordinary invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an ordinary invoice (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/95\",
\"discount-percentage\": 0,
\"total-amount\": 91.86,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/87\",
\"path\": \"app.stelorder.com/app/ordinaryInvoices/60\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/56\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/salesDeliveryNotes/59\",
\"addendum\": null,
\"id\": 60,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 86,
\"document-state-id\": 87,
\"serial-number-id\": 56,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 14,
\"account-id\": 95,
\"settled\": false,
\"parent-document-id\": 59,
\"signed\": false,
\"tax-total-amount\": 15.31,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"paid-total-amount\": 91.86,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"creation-date\": \"2016-11-28T16:58:37+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/14\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 76.55,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 15.31
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/86\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/60\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 24.2,
\"deleted\": false,
\"item-id\": 60,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Spice Variety\",
\"item-deleted\": false,
\"item-description\": \"Multiple spices imported from India.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 246,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 12.1
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/73\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 10,
\"deleted\": false,
\"item-id\": 73,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Local Transport Service Costs\",
\"item-deleted\": false,
\"item-description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 247,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 10
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/67\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 5,
\"discount-percentage\": 0,
\"total-amount\": 42.35,
\"deleted\": false,
\"item-id\": 67,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Rose Cupcakes (5 units)\",
\"item-deleted\": false,
\"item-description\": \"Chocolate and vanilla cream filled cupcakes. Decorated with edible roses.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 245,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 8.47
}
],
\"sent-date\": null,
\"payment-terms-id\": 1,
\"payment-terms-path\": \"app.stelorder.com/app/paymentTerms/1\",
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 76.55,
\"delivery-option-path\": null,
\"remaining-total-amount\": 0,
\"signature-name\": null,
\"parent-incident-path\": null,
\"receipts\": [
{
\"path\": \"app.stelorder.com/app/ordinaryInvoiceReceipts/31\",
\"id\": 31
}],
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"INV00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["OrdinaryInvoices"],"summary":"Resource to update an existing ordinary invoice","operationId":"doPut_15","parameters":[{"name":"ID","in":"path","description":"ID of ordinary invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/OrdinaryInvoicePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["OrdinaryInvoices"],"summary":"Resource to delete an existing ordinary invoice","operationId":"doDelete_14","parameters":[{"name":"ID","in":"path","description":"ID of ordinary invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/paymentOptions":{"get":{"tags":["PaymentOptions"],"summary":"Resource to get a payment option or a list of payment options. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_27","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"default","in":"query","description":"Filter clause (examples -> 'default=true')
","schema":{"type":"boolean"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, default, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns payment option list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"subject-to-sepa-payment\": false,
\"path\": \"app.stelorder.com/app/paymentOptions/11\",
\"default\": false,
\"deleted\": false,
\"linked-to-bank-account\": true,
\"name\": \"Bank Transfer\",
\"description\": \"A wire transfer, bank transfer or credit transfer is a method of electronic funds transfer from one person or entity to another. \",
\"countable-account\": null,
\"id\": 11,
\"mxn-cfdi-key\": \"99\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["PaymentOptions"],"summary":"Resource to create a new payment options","operationId":"doPost_18","requestBody":{"description":"Minimum body:
{
\"name\": \"Cash\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PaymentOptionPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/paymentOptions/{ID}":{"get":{"tags":["PaymentOptions"],"summary":"Resource to get a payment option by ID.","operationId":"doGetById_25","parameters":[{"name":"ID","in":"path","description":"ID of payment option","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a payment option (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"subject-to-sepa-payment\": false,
\"path\": \"app.stelorder.com/app/paymentOptions/11\",
\"default\": false,
\"deleted\": false,
\"linked-to-bank-account\": true,
\"name\": \"Bank Transfer\",
\"description\": \"A wire transfer, bank transfer or credit transfer is a method of electronic funds transfer from one person or entity to another. \",
\"countable-account\": null,
\"id\": 11,
\"mxn-cfdi-key\": \"99\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["PaymentOptions"],"summary":"Resource to update an existing payment option","operationId":"doPut_16","parameters":[{"name":"ID","in":"path","description":"ID of payment option","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PaymentOptionPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["PaymentOptions"],"summary":"Resource to delete an existing payment options","operationId":"doDelete_15","parameters":[{"name":"ID","in":"path","description":"ID of payment options","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/paymentTerms/{ID}":{"get":{"tags":["PaymentTerms"],"summary":"Resource to get a payment terms by ID.","operationId":"doGetById_26","parameters":[{"name":"ID","in":"path","description":"ID of payment terms","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a payment terms (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/paymentTerms/1\",
\"deleted\": false,
\"name\": \"30-60-90 Days Payment\",
\"description\": \"A three installment payment term that takes place every 30 days.\",
\"id\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/paymentTerms":{"get":{"tags":["PaymentTerms"],"summary":"Resource to get a payment terms or a list of payment terms. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_28","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns payment terms list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/paymentTerms/1\",
\"deleted\": false,
\"name\": \"30-60-90 Days Payment\",
\"description\": \"A three installment payment term that takes place every 30 days.\",
\"id\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/potentialClients":{"get":{"tags":["PotentialClients"],"summary":"Resource to get a potential client or a list of potential clients. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_29","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"legal-name","in":"query","description":"Filter clause (examples -> 'legal-name=foo', 'legal-name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"tax-identification-number","in":"query","description":"Filter clause (examples -> 'tax-identification-number=foo', 'tax-identification-number=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter clause (examples -> 'email=foo', 'email=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Filter clause (examples -> 'phone=612345678', 'phone=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"phone2","in":"query","description":"Filter clause (examples -> 'phone2=612345678', 'phone2=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"fax","in":"query","description":"Filter clause (examples -> 'fax=612345678', 'fax=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-category-id","in":"query","description":"Filter clause (examples -> 'account-category-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"rate-id","in":"query","description":"Filter clause (examples -> 'rate-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=account-category-id:asc,name:asc,reference:desc')
Sorting fields allowed: full-reference, reference, legal-name, name, tax-identification-number, email, phone, phone2, fax, creation-date, external-id, serial-number-id, account-category-id, rate-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a potential clients list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"client-category-path\": \"app/clientCategories/5\",
\"phone2\": null,
\"payment-day\": null,
\"special-prices\": [
{
\"item-path\": \"app.stelorder.com/app/services/6852234\",
\"item-id\": 6852234,
\"price\": 6
},
{
\"item-path\": \"app.stelorder.com/app/products/6852296\",
\"item-id\": 6852296,
\"price\": 100
}
],
\"discount-percentage\": 0,
\"client-category-id\": 5,
\"identification-number\": \"B99999999\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"phone\": \"96666666\",
\"reference\": \"000002\",
\"path\": \"app/potentialClients/68\",
\"primary-tax-enabled\": true,
\"serial-number-path\": \"app/serialNumbers/30\",
\"rate-path\": null,
\"legal-name\": \"Peter of the sticks\",
\"currency\": \"EUR\",
\"id\": 68,
\"fax\": null,
\"income-tax-enabled\": false,
\"email\": \"info@info.com\",
\"main-address\": {
\"country-code\": \"ES\",
\"address-type-name\": \"Default\",
\"city-town\": \"Toledo\",
\"extra-data\": null,
\"path\": \"app/addresses/55\",
\"account-path\": \"app/potentialClients/68\",
\"account-id\": 68,
\"latitude\": 1.33,
\"longitude\": -2.55,
\"postal-code\": \"45004\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"province\": \"Toledo\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"name\": \"Default address\",
\"id\": 55,
\"formatted-address\": \"Paseo Cristo de la Vega, 12\",
\"address-data\": \"Paseo Cristo de la Vega, 12\"
},
\"bank-account\": {
\"deleted\": false,
\"account-id\": 68,
\"name\": null,
\"description\": null,
\"utc-last-modification-date\": \"2023-03-13T10:06:58+0000\",
\"account\": \"21218617\",
\"account-path\": \"app.stelorder.com/app/potentialClients/68\",
\"bic-swift\": null
},
\"payment-terms-id\": null,
\"payment-terms-path\": null,
\"agent-id\": null,
\"website\": \"www.petersticks.com\",
\"serial-number-id\": 30,
\"comments\": null,
\"payment-option-id\": null,
\"countable-account\": null,
\"secondary-tax-enabled\": false,
\"payment-adjustment\": null,
\"agent-path\": null,
\"deleted\": false,
\"rate-id\": null,
\"name\": \"Peter sticks\",
\"creation-date\": \"25/07/2016 13:16:28\",
\"currency-position\": \"RIGHT\",
\"payment-option-path\": null,
\"full-reference\": \"CLI000002\",
\"currency-code\": \"EUR\",
\"currency-symbol\": \"€\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["PotentialClients"],"summary":"Resource to create a new potential client","operationId":"doPost_19","requestBody":{"description":"Minimum body:
{
\"legal-name\": \"John\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PotentialClientPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/potentialClients/{ID}":{"get":{"tags":["PotentialClients"],"summary":"Resource to get a potential client by ID.","operationId":"doGetById_27","parameters":[{"name":"ID","in":"path","description":"ID of potential client","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a potential client (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"client-category-path\": \"app/clientCategories/5\",
\"phone2\": null,
\"payment-day\": null,
\"special-prices\": [
{
\"item-path\": \"app.stelorder.com/app/services/6852234\",
\"item-id\": 6852234,
\"price\": 6
},
{
\"item-path\": \"app.stelorder.com/app/products/6852296\",
\"item-id\": 6852296,
\"price\": 100
}
],
\"discount-percentage\": 0,
\"client-category-id\": 5,
\"identification-number\": \"B99999999\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"phone\": \"96666666\",
\"reference\": \"000002\",
\"path\": \"app/potentialClients/68\",
\"primary-tax-enabled\": true,
\"serial-number-path\": \"app/serialNumbers/30\",
\"rate-path\": null,
\"legal-name\": \"Peter of the sticks\",
\"currency\": \"EUR\",
\"id\": 68,
\"fax\": null,
\"income-tax-enabled\": false,
\"email\": \"info@info.com\",
\"main-address\": {
\"country-code\": \"ES\",
\"address-type-name\": \"Default\",
\"city-town\": \"Toledo\",
\"extra-data\": null,
\"path\": \"app/addresses/55\",
\"account-path\": \"app/potentialClients/68\",
\"account-id\": 68,
\"latitude\": 1.33,
\"longitude\": -2.55,
\"postal-code\": \"45004\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"province\": \"Toledo\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"name\": \"Default address\",
\"id\": 55,
\"formatted-address\": \"Paseo Cristo de la Vega, 12\",
\"address-data\": \"Paseo Cristo de la Vega, 12\"
},
\"bank-account\": {
\"deleted\": false,
\"account-id\": 68,
\"name\": null,
\"description\": null,
\"utc-last-modification-date\": \"2023-03-13T10:06:58+0000\",
\"account\": \"21218617\",
\"account-path\": \"app.stelorder.com/app/potentialClients/68\",
\"bic-swift\": null
},
\"payment-terms-id\": null,
\"payment-terms-path\": null,
\"agent-id\": null,
\"website\": \"www.petersticks.com\",
\"serial-number-id\": 30,
\"comments\": null,
\"payment-option-id\": null,
\"countable-account\": null,
\"secondary-tax-enabled\": false,
\"payment-adjustment\": null,
\"agent-path\": null,
\"deleted\": false,
\"rate-id\": null,
\"name\": \"Peter sticks\",
\"creation-date\": \"25/07/2016 13:16:28\",
\"currency-position\": \"RIGHT\",
\"payment-option-path\": null,
\"full-reference\": \"CLI000002\",
\"currency-code\": \"EUR\",
\"currency-symbol\": \"€\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["PotentialClients"],"summary":"Resource to update an existing potential client","operationId":"doPut_17","parameters":[{"name":"ID","in":"path","description":"ID of potential client","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PotentialClientPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["PotentialClients"],"summary":"Resource to delete an existing potential client","operationId":"doDelete_16","parameters":[{"name":"ID","in":"path","description":"ID of potential client","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/productCategories":{"get":{"tags":["ProductCategories"],"summary":"Resource to get a product category or a list of product categories. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_30","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns product categories list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/productCategories/17\",
\"deleted\": false,
\"name\": \"Beauty\",
\"description\": null,
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["ProductCategories"],"summary":"Resource to create a new product category","operationId":"doPost_20","requestBody":{"description":"Minimum body:
{
\"name\": \"John\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ProductCategoryPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/productCategories/{ID}":{"get":{"tags":["ProductCategories"],"summary":"Resource to get a product category by ID.","operationId":"doGetById_28","parameters":[{"name":"ID","in":"path","description":"ID of product category","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a product category (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/productCategories/17\",
\"deleted\": false,
\"name\": \"Beauty\",
\"description\": null,
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["ProductCategories"],"summary":"Resource to update an existing product category","operationId":"doPut_18","parameters":[{"name":"ID","in":"path","description":"ID of product category","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ProductCategoryPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["ProductCategories"],"summary":"Resource to delete an existing product category","operationId":"doDelete_17","parameters":[{"name":"ID","in":"path","description":"ID of product category","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/productComponents":{"get":{"tags":["ProductComponents"],"summary":"Resource to get a product component or a list of product components. The list is limited to 100 product components per request by default but can be increased to 500 using limit clause.","operationId":"doGet_31","parameters":[{"name":"order","in":"query","description":"Filter clause (examples -> 'order=0')
","schema":{"type":"integer","format":"int64"}},{"name":"units","in":"query","description":"Filter clause (examples -> 'units=0')
","schema":{"type":"integer","format":"int64"}},{"name":"item-id","in":"query","description":"Filter clause (examples -> 'item-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"component-id","in":"query","description":"Filter clause (examples -> 'component-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=order', 'sort=order:asc,item-id:desc')
Sorting fields allowed: order, units, item-id, component-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 product components)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns product components list (if there are any result)
[{
\"units\": 1,
\"component-path\": \"app.stelorder.com/app/products/6852295\",
\"component-id\": 6852295,
\"item-path\": \"app.stelorder.com/app/products/6852299\",
\"item-id\": 6852299,
\"deleted\": false,
\"id\": 728729,
\"utc-last-modification-date\": \"2020-03-02T13:33:41+0000\",
\"order\": 0
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["ProductComponents"],"summary":"Resource to upload a product component","operationId":"doPost_21","requestBody":{"description":"Minimum body:
{
\"item-id\": 6852295,
\"component-id\": 2414
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ProductComponentPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/productComponents/{ID}":{"get":{"tags":["ProductComponents"],"summary":"Resource to get a product component by ID.","operationId":"doGetById_29","parameters":[{"name":"ID","in":"path","description":"ID of product component","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a product component (if there are any result)
[{
\"units\": 1,
\"component-path\": \"app.stelorder.com/app/products/6852295\",
\"component-id\": 6852295,
\"item-path\": \"app.stelorder.com/app/products/6852299\",
\"item-id\": 6852299,
\"deleted\": false,
\"id\": 728729,
\"utc-last-modification-date\": \"2020-03-02T13:33:41+0000\",
\"order\": 0
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["ProductComponents"],"summary":"Resource to update an existing product component","operationId":"doPut_19","parameters":[{"name":"ID","in":"path","description":"ID of product component","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ProductComponentPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["ProductComponents"],"summary":"Resource to delete an existing product component","operationId":"doDelete_18","parameters":[{"name":"ID","in":"path","description":"ID of product component","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/productWarehouses":{"get":{"tags":["ProductWarehouses"],"summary":"Resource to get a product warehouse or a list of product warehouses. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_32","parameters":[{"name":"below-minimum-stock","in":"query","description":"Filter clause (examples -> 'below-minimum-stock=true')
","schema":{"type":"boolean"}},{"name":"negative-stock","in":"query","description":"Filter clause (examples -> 'negative-stock=true')
","schema":{"type":"boolean"}},{"name":"item-id","in":"query","description":"Filter clause (examples -> 'item-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"warehouse-id","in":"query","description":"Filter clause (examples -> 'warehouse-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=real-stock', 'sort=real-stock:asc,minimum-stock:desc')
Sorting fields allowed: real-stock, virtual-stock, minimum-stock, location, item-id, warehouse-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a product warehouses items list (if there are any result)
[{
\"deleted\": false,
\"utc-last-modification-date\": \"2023-04-24T14:15:38+0000\",
\"item-path\": \"app.stelorder.com/app/products/20914091\",
\"warehouse-id\": -2,
\"item-id\": 20914091,
\"minimum-stock\": 0,
\"location\": null,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"real-stock\": 0,
\"virtual-stock\": 0
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["ProductWarehouses"],"summary":"Resource to update an existing product warehouse","operationId":"doPut_20","requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ProductWarehousePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/products":{"get":{"tags":["Products"],"summary":"Resource to get a product or a list of products. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_33","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"private-comments","in":"query","description":"Filter clause (examples -> 'private-comments=foo', 'private-comments=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"barcode","in":"query","description":"Filter clause (examples -> 'barcode=foo', 'barcode=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"promotional","in":"query","description":"Filter clause (examples -> 'promotional=true')
","schema":{"type":"boolean"}},{"name":"inactive","in":"query","description":"Filter clause (examples -> 'inactive=true')
","schema":{"type":"boolean"}},{"name":"composite","in":"query","description":"Filter clause (examples -> 'composite=true')
","schema":{"type":"boolean"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (example -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"product-category-id","in":"query","description":"Filter clause (examples -> 'product-category-id=1'product-category-id=1,2,3')
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: full-reference, reference, name, description, private-comments, barcode, creation-date, external-id, serial-number-id, product-category-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a products list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"primary-tax-percentage\": 10,
\"description\": \"A safe and comfortable way to store documents and other office items\",
\"product-category-path\": \"app.stelorder.com/app/productCategories/15\",
\"discount-percentage\": 0,
\"reference\": \"00005\",
\"path\": \"app.stelorder.com/app/products/58\",
\"private-comments\": null,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/52\",
\"inactive\": false,
\"sales-price\": 18.8,
\"sales-minimum-price\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/37273\",
\"external-id\": null,
\"id\": 58,
\"real-stock\": 39,
\"location\": \"Location in warehouse\",
\"purchase-price\": 11,
\"product-category-id\": 15,
\"barcode\": \"8429096081111\",
\"promotional\": false,
\"serial-number-id\": 52,
\"item-rates\": [
{
\"rate-path\": \"app.stelorder.com/app/rates/2807\",
\"rate-id\": 2807,
\"price\": 15
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2808\",
\"rate-id\": 2808,
\"price\": 16
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2809\",
\"rate-id\": 2809,
\"price\": 17
}
],
\"product-warehouses\": [
{
\"warehouse-id\": -2,
\"minimum-stock\": 200,
\"location\": \"\",
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"real-stock\": 220,
\"virtual-stock\": 220
}
],
\"stock-enabled\": true,
\"minimum-stock\": 0,
\"composite\": 0,
\"composite-sales-price\": \"PRICE\",
\"composite-margin-sales-price\": 1,
\"composite-document-behavior\": \"SHOW\",
\"composite-pdf-behavior\": \"SHOW\",
\"product-components\": [
],
\"sales-countable-account\": null,
\"purchase-margin-percentage\": 70.91,
\"deleted\": false,
\"secondary-tax-percentage\": 0,
\"item-images\": [
{
\"item-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"name\": \"Folders (6 Pack)\",
\"creation-date\": \"2016-11-28T12:54:57+0000\",
\"sales-margin-percentage\": 41.49,
\"purchase-countable-account\": null,
\"primary-tax-id\": 37273,
\"virtual-stock\": 34,
\"full-reference\": \"PRO00005\",
\"margin-enabled\": false
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Products"],"summary":"Resource to create a new product","operationId":"doPost_22","requestBody":{"description":"Minimum body:
{
\"name\": \"Life Eyeshadow (3x4 Pack)\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ProductPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/products/{ID}":{"get":{"tags":["Products"],"summary":"Resource to get a product by ID.","operationId":"doGetById_30","parameters":[{"name":"ID","in":"path","description":"ID of product","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a product (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"primary-tax-percentage\": 10,
\"description\": \"A safe and comfortable way to store documents and other office items\",
\"product-category-path\": \"app.stelorder.com/app/productCategories/15\",
\"discount-percentage\": 0,
\"reference\": \"00005\",
\"path\": \"app.stelorder.com/app/products/58\",
\"private-comments\": null,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/52\",
\"inactive\": false,
\"sales-price\": 18.8,
\"sales-minimum-price\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/37273\",
\"external-id\": null,
\"id\": 58,
\"real-stock\": 39,
\"location\": \"Location in warehouse\",
\"purchase-price\": 11,
\"product-category-id\": 15,
\"barcode\": \"8429096081111\",
\"promotional\": false,
\"serial-number-id\": 52,
\"item-rates\": [
{
\"rate-path\": \"app.stelorder.com/app/rates/2807\",
\"rate-id\": 2807,
\"price\": 15
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2808\",
\"rate-id\": 2808,
\"price\": 16
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2809\",
\"rate-id\": 2809,
\"price\": 17
}
],
\"product-warehouses\": [
{
\"warehouse-id\": -2,
\"minimum-stock\": 200,
\"location\": \"\",
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"real-stock\": 220,
\"virtual-stock\": 220
}
],
\"stock-enabled\": true,
\"minimum-stock\": 0,
\"composite\": 0,
\"composite-sales-price\": \"PRICE\",
\"composite-margin-sales-price\": 1,
\"composite-document-behavior\": \"SHOW\",
\"composite-pdf-behavior\": \"SHOW\",
\"product-components\": [
],
\"sales-countable-account\": null,
\"purchase-margin-percentage\": 70.91,
\"deleted\": false,
\"secondary-tax-percentage\": 0,
\"item-images\": [
{
\"item-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"name\": \"Folders (6 Pack)\",
\"creation-date\": \"2016-11-28T12:54:57+0000\",
\"sales-margin-percentage\": 41.49,
\"purchase-countable-account\": null,
\"primary-tax-id\": 37273,
\"virtual-stock\": 34,
\"full-reference\": \"PRO00005\",
\"margin-enabled\": false
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Products"],"summary":"Resource to update an existing product","operationId":"doPut_21","parameters":[{"name":"ID","in":"path","description":"ID of product","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ProductPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Products"],"summary":"Resource to delete an existing product","operationId":"doDelete_19","parameters":[{"name":"ID","in":"path","description":"ID of product","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseDeliveryNotes":{"get":{"tags":["PurchaseDeliveryNotes"],"summary":"Resource to get a purchase delivery note or a list of purchase delivery notes. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_34","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all purchase delivery notes from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all purchase delivery notes until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified purchase delivery notes from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a purchase delivery note list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-29T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/102\",
\"discount-percentage\": 0,
\"total-amount\": 1650,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/101\",
\"path\": \"app.stelorder.com/app/purchaseDeliveryNotes/82\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/42\",
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/purchaseOrders/81\",
\"addendum\": null,
\"id\": 82,
\"income-tax-enabled\": false,
\"document-state-id\": 101,
\"serial-number-id\": 42,
\"email-read-count\": 0,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"extra-reference\": null,
\"payment-option-id\": 12,
\"account-id\": 102,
\"settled\": false,
\"parent-document-id\": 81,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": 275,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"secondary-tax-enabled\": false,
\"creation-date\": \"2016-11-29T10:56:38+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/12\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 1375,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": 275
}
],
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/57\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 100,
\"discount-percentage\": 0,
\"total-amount\": 650,
\"deleted\": false,
\"item-id\": 57,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Life Eyeshadow (3x4 Pack)\",
\"item-deleted\": false,
\"item-description\": \"Life eyeshadow are ideal for day to day usage as well as special occasions.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 308,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 6.5
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/62\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 100,
\"discount-percentage\": 0,
\"total-amount\": 425,
\"deleted\": false,
\"item-id\": 62,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Chik Lipstick\",
\"item-deleted\": false,
\"item-description\": \"Our Chik lipstick comes in 3 colors: orange, red and purple. Chik lipsticks are made with natural products and components.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 310,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 4.25
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/65\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 100,
\"discount-percentage\": 0,
\"total-amount\": 300,
\"deleted\": false,
\"item-id\": 65,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Wow Rogue (3 Pack)\",
\"item-deleted\": false,
\"item-description\": \"The Wow rogue is made using natural components. Its texture is soft and designed for any type of skin.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 309,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 3
}
],
\"sent-date\": null,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 1375,
\"delivery-option-path\": null,
\"creator-id\": 1,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"PDN00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["PurchaseDeliveryNotes"],"summary":"Resource to create a new purchase delivery note","operationId":"doPost_23","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNotePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseDeliveryNotes/{ID}":{"get":{"tags":["PurchaseDeliveryNotes"],"summary":"Resource to get a purchase delivery note by ID.","operationId":"doGetById_31","parameters":[{"name":"ID","in":"path","description":"ID of purchase delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a purchase delivery note (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-29T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/102\",
\"discount-percentage\": 0,
\"total-amount\": 1650,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/101\",
\"path\": \"app.stelorder.com/app/purchaseDeliveryNotes/82\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/42\",
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/purchaseOrders/81\",
\"addendum\": null,
\"id\": 82,
\"income-tax-enabled\": false,
\"document-state-id\": 101,
\"serial-number-id\": 42,
\"email-read-count\": 0,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"extra-reference\": null,
\"payment-option-id\": 12,
\"account-id\": 102,
\"settled\": false,
\"parent-document-id\": 81,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": 275,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"secondary-tax-enabled\": false,
\"creation-date\": \"2016-11-29T10:56:38+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/12\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 1375,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": 275
}
],
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/57\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 100,
\"discount-percentage\": 0,
\"total-amount\": 650,
\"deleted\": false,
\"item-id\": 57,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-name\": \"Life Eyeshadow (3x4 Pack)\",
\"item-deleted\": false,
\"item-reference\": \"PRO00001\",
\"item-description\": \"Life eyeshadow are ideal for day to day usage as well as special occasions.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 308,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 6.5
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/62\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 100,
\"discount-percentage\": 0,
\"total-amount\": 425,
\"deleted\": false,
\"item-id\": 62,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Chik Lipstick\",
\"item-deleted\": false,
\"item-description\": \"Our Chik lipstick comes in 3 colors: orange, red and purple. Chik lipsticks are made with natural products and components.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 310,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 4.25
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/65\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 100,
\"discount-percentage\": 0,
\"total-amount\": 300,
\"deleted\": false,
\"item-id\": 65,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Wow Rogue (3 Pack)\",
\"item-deleted\": false,
\"item-description\": \"The Wow rogue is made using natural components. Its texture is soft and designed for any type of skin.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 309,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 3
}
],
\"sent-date\": null,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 1375,
\"delivery-option-path\": null,
\"creator-id\": 1,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"PDN00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["PurchaseDeliveryNotes"],"summary":"Resource to update an existing purchase delivery note","operationId":"doPut_22","parameters":[{"name":"ID","in":"path","description":"ID of purchase delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PurchaseDeliveryNotePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["PurchaseDeliveryNotes"],"summary":"Resource to delete an existing purchase delivery note","operationId":"doDelete_20","parameters":[{"name":"ID","in":"path","description":"ID of purchase delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseInvoiceReceipts/{ID}":{"get":{"tags":["PurchaseInvoiceReceipts"],"summary":"Resource to get a purchase invoice receipt by ID.","operationId":"doGetById_32","parameters":[{"name":"ID","in":"path","description":"ID of purchase invoice receipt","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a purchase invoice receipt (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"concept\": null,
\"currency-rate\": 1,
\"bank-account-id\": null,
\"payment-date\": \"2016-11-29T10:58:09+0000\",
\"account-path\": \"app.stelorder.com/app/suppliers/105\",
\"path\": \"app.stelorder.com/app/purchaseInvoiceReceipts/39\",
\"original-element-id\": 40,
\"paid-employee-id\": null,
\"id\": 39,
\"creator-id\": 1,
\"amount\": 936,
\"payment-option-id\": 12,
\"account-id\": 105,
\"settled\": false,
\"bank-account-path\": null,
\"paid-employee-path\": \"app.stelorder.com/app/employees/1\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"original-element-path\": \"app.stelorder.com/app/purchaseInvoices/40\",
\"paid\": true,
\"payment-term-date\": \"2016-11-29T00:00:00+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/12\",
\"full-reference\": \"PINV00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["PurchaseInvoiceReceipts"],"summary":"Resource to update an existing purchase invoice receipt","operationId":"doPut_23","parameters":[{"name":"ID","in":"path","description":"ID of purchase invoice receipt","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PurchaseInvoiceReceiptPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseInvoiceReceipts":{"get":{"tags":["PurchaseInvoiceReceipts"],"summary":"Resource to get a purchase invoice receipt or a list of purchase invoice receipts. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_35","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"concept","in":"query","description":"Filter clause (examples -> 'concept=foo', 'concept=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"amount","in":"query","description":"Filter clause (examples -> 'amount=30)
","schema":{"type":"number","format":"double"}},{"name":"paid","in":"query","description":"Filter clause (examples -> 'paid=true)'
","schema":{"type":"boolean"}},{"name":"payment-term-date","in":"query","description":"Filter clause (examples -> 'payment-term-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-payment-term-date","in":"query","description":"Filter all purchase invoice receipts from payment-term-date(examples -> start-payment-term-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-payment-term-date","in":"query","description":"Filter all purchase invoice receipts until payment-term-date(examples -> end-payment-term-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"payment-date","in":"query","description":"Filter clause (examples -> 'payment-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-payment-date","in":"query","description":"Filter all purchase invoice receipts from payment-date (examples -> 'start-payment-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-payment-date","in":"query","description":"Filter all purchase invoice receipts until payment-date (examples -> 'end-payment-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"settled","in":"query","description":"Filter clause (examples -> 'settled=true)'
","schema":{"type":"boolean"}},{"name":"original-element-id","in":"query","description":"Filter clause (examples -> 'original-element-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"paid-employee-id","in":"query","description":"Filter clause (examples -> 'paid-employee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"payment-option-id","in":"query","description":"Filter clause (examples -> 'payment-option-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"bank-account-id","in":"query","description":"Filter clause (examples -> 'bank-account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=concept', 'sort=concept:asc,full-reference:desc')
Sorting fields allowed:
concept, amount, full-reference, paid, payment-term-date, payment-date, settled, original-element-id, account-id, creator-id, paid-employee-id, payment-option-id, bank-account-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns purchase invoice receipts list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"concept\": null,
\"currency-rate\": 1,
\"bank-account-id\": null,
\"payment-date\": \"2016-11-29T10:58:09+0000\",
\"account-path\": \"app.stelorder.com/app/suppliers/105\",,
\"path\": \"app.stelorder.com/app/purchaseInvoiceReceipts/39\",
\"original-element-id\": 40,
\"paid-employee-id\": null,
\"id\": 39,
\"creator-id\": 1,
\"amount\": 936,
\"payment-option-id\": 12,
\"account-id\": 105,
\"settled\": false,
\"bank-account-path\": null,
\"paid-employee-path\": \"app.stelorder.com/app/employees/1\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"original-element-path\": \"app.stelorder.com/app/purchaseInvoices/40\",
\"paid\": true,
\"payment-term-date\": \"2016-11-29T00:00:00+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/12\",
\"full-reference\": \"PINV00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseInvoices":{"get":{"tags":["PurchaseInvoices"],"summary":"Resource to get an purchase invoice or a list of purchase invoices. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_36","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all purchase invoices from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all purchase invoices until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified purchase invoices from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an purchase invoices list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-29T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/105\",
\"discount-percentage\": 0,
\"total-amount\": 936,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/103\",
\"path\": \"app.stelorder.com/app/purchaseInvoices/84\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/60\",
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/purchaseDeliveryNotes/83\",
\"addendum\": null,
\"id\": 84,
\"income-tax-enabled\": false,
\"document-state-id\": 103,
\"serial-number-id\": 60,
\"email-read-count\": 0,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"extra-reference\": null,
\"payment-option-id\": 12,
\"account-id\": 105,
\"settled\": false,
\"parent-document-id\": 83,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": 156,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"paid-total-amount\": 936,
\"secondary-tax-enabled\": false,
\"creation-date\": \"2016-11-29T10:57:27+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/12\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 780,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": 156
}
],
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"lines\":[
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/63\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 10,
\"discount-percentage\": 0,
\"total-amount\": 230,
\"deleted\": false,
\"item-id\": 63,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-name\": \"Storage Box (Plastic)\",
\"item-deleted\": false,
\"item-description\": \"Plastic boxes designed for offices, worshops and more. Very useful to store documents and tools as well as keeping them close and safe.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 316,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 23
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/61\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 10,
\"discount-percentage\": 0,
\"total-amount\": 200,
\"deleted\": false,
\"item-id\": 61,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-name\": \"Industrial Gloves (Skin)\",
\"item-deleted\": false,
\"item-description\": \"Not only are they comfortable, they will also keep your hands safe!\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 314,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 20
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/68\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 10,
\"discount-percentage\": 0,
\"total-amount\": 350,
\"deleted\": false,
\"item-id\": 68,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-name\": \"Electrical Screwdriver (Pack)\",
\"item-deleted\": false,
\"item-description\": \"With a wide variety of different heads as well as instructions for safe use.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 315,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 35
}
],
\"sent-date\": null,
\"payment-terms-id\": 1,
\"payment-terms-path\": \"app.stelorder.com/app/paymentTerms/1\",
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 780,
\"delivery-option-path\": null,
\"remaining-total-amount\": 0,
\"creator-id\": 1,
\"signature-name\": null,
\"parent-incident-path\": null,
\"receipts\": [,
{
\"path\": \"app.stelorder.com/app/purchaseInvoiceReceipts/39\",
\"id\": 39
},
],
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"PINV00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["PurchaseInvoices"],"summary":"Resource to create a new purchase invoice","operationId":"doPost_24","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PurchaseInvoicePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseInvoices/{ID}":{"get":{"tags":["PurchaseInvoices"],"summary":"Resource to get a purchase invoice by ID.","operationId":"doGetById_33","parameters":[{"name":"ID","in":"path","description":"ID of purchase invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a purchase invoice (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-29T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/105\",
\"discount-percentage\": 0,
\"total-amount\": 936,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/103\",
\"path\": \"app.stelorder.com/app/purchaseInvoices/84\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/60\",
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/purchaseDeliveryNotes/83\",
\"addendum\": null,
\"id\": 84,
\"income-tax-enabled\": false,
\"document-state-id\": 103,
\"serial-number-id\": 60,
\"email-read-count\": 0,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"extra-reference\": null,
\"payment-option-id\": 12,
\"account-id\": 105,
\"settled\": false,
\"parent-document-id\": 83,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": 156,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"paid-total-amount\": 936,
\"secondary-tax-enabled\": false,
\"creation-date\": \"2016-11-29T10:57:27+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/12\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 780,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": 156
}
],
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"lines\":[
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/63\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 10,
\"discount-percentage\": 0,
\"total-amount\": 230,
\"deleted\": false,
\"item-id\": 63,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-name\": \"Storage Box (Plastic)\",
\"item-deleted\": false,
\"item-description\": \"Plastic boxes designed for offices, worshops and more. Very useful to store documents and tools as well as keeping them close and safe.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 316,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 23
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/61\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 10,
\"discount-percentage\": 0,
\"total-amount\": 200,
\"deleted\": false,
\"item-id\": 61,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-name\": \"Industrial Gloves (Skin)\",
\"item-deleted\": false,
\"item-description\": \"Not only are they comfortable, they will also keep your hands safe!\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 314,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 20
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/68\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 10,
\"discount-percentage\": 0,
\"total-amount\": 350,
\"deleted\": false,
\"item-id\": 68,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-name\": \"Electrical Screwdriver (Pack)\",
\"item-deleted\": false,
\"item-description\": \"With a wide variety of different heads as well as instructions for safe use.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 315,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 35
}
],
\"sent-date\": null,
\"payment-terms-id\": 1,
\"payment-terms-path\": \"app.stelorder.com/app/paymentTerms/1\",
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 780,
\"delivery-option-path\": null,
\"remaining-total-amount\": 0,
\"creator-id\": 1,
\"signature-name\": null,
\"parent-incident-path\": null,
\"receipts\": [,
{
\"path\": \"app.stelorder.com/app/purchaseInvoiceReceipts/39\",
\"id\": 39
},
],
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"PINV00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["PurchaseInvoices"],"summary":"Resource to update an existing purchase invoice","operationId":"doPut_24","parameters":[{"name":"ID","in":"path","description":"ID of purchase invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PurchaseInvoicePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["PurchaseInvoices"],"summary":"Resource to delete an existing purchase invoice","operationId":"doDelete_21","parameters":[{"name":"ID","in":"path","description":"ID of purchase invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseOrders":{"get":{"tags":["PurchaseOrders"],"summary":"Resource to get a purchase order or a list of purchase orders. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_37","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all purchase orders from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all purchase orders until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified purchase orders from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a purchase order list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-29T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/104\",
\"discount-percentage\": 0,
\"total-amount\": 846,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/114\",
\"path\": \"app.stelorder.com/app/purchaseOrders/79\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/51\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 79,
\"income-tax-enabled\": false,
\"document-state-id\": 114,
\"serial-number-id\": 51,
\"email-read-count\": 0,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"extra-reference\": null,
\"payment-option-id\": 11,
\"account-id\": 104,
\"settled\": false,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": 141,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"secondary-tax-enabled\": false,
\"creation-date\": \"2016-11-29T10:50:57+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 705,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": 141
}],
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/67\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 50,
\"discount-percentage\": 0,
\"total-amount\": 322.5,
\"deleted\": false,
\"item-id\": 67,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Rose Cupcakes (5 units)\",
\"item-deleted\": false,
\"item-description\": \"Chocolate and vanilla cream filled cupcakes. Decorated with edible roses.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 301,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 6.45
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/60\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 50,
\"discount-percentage\": 0,
\"total-amount\": 382.5,
\"deleted\": false,
\"item-id\": 60,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Spice Variety\",
\"item-deleted\": false,
\"item-description\": \"Multiple spices imported from India.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 300,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 7.65
}
],
\"sent-date\": null,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 705,
\"delivery-option-path\": null,
\"creator-id\": 1,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"PO00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["PurchaseOrders"],"summary":"Resource to create a new purchase order","operationId":"doPost_25","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PurchaseOrderPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/purchaseOrders/{ID}":{"get":{"tags":["PurchaseOrders"],"summary":"Resource to get a purchase order by ID.","operationId":"doGetById_34","parameters":[{"name":"ID","in":"path","description":"ID of purchase order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a purchase order (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-29T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/suppliers/104\",
\"discount-percentage\": 0,
\"total-amount\": 846,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/114\",
\"path\": \"app.stelorder.com/app/purchaseOrders/79\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/51\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 79,
\"income-tax-enabled\": false,
\"document-state-id\": 114,
\"serial-number-id\": 51,
\"email-read-count\": 0,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"extra-reference\": null,
\"payment-option-id\": 11,
\"account-id\": 104,
\"settled\": false,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": 141,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"secondary-tax-enabled\": false,
\"creation-date\": \"2016-11-29T10:50:57+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 705,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": 141
}],
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/67\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 50,
\"discount-percentage\": 0,
\"total-amount\": 322.5,
\"deleted\": false,
\"item-id\": 67,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Rose Cupcakes (5 units)\",
\"item-deleted\": false,
\"item-description\": \"Chocolate and vanilla cream filled cupcakes. Decorated with edible roses.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 301,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 6.45
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/60\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": 50,
\"discount-percentage\": 0,
\"total-amount\": 382.5,
\"deleted\": false,
\"item-id\": 60,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Spice Variety\",
\"item-deleted\": false,
\"item-description\": \"Multiple spices imported from India.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 300,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-base-price\": 7.65
}
],
\"sent-date\": null,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 705,
\"delivery-option-path\": null,
\"creator-id\": 1,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"PO00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["PurchaseOrders"],"summary":"Resource to update an existing purchase order","operationId":"doPut_25","parameters":[{"name":"ID","in":"path","description":"ID of purchase order","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/PurchaseOrderPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["PurchaseOrders"],"summary":"Resource to delete an existing purchase order","operationId":"doDelete_22","parameters":[{"name":"ID","in":"path","description":"ID of purchase order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/rates":{"get":{"tags":["Rates"],"summary":"Resource to get a rate or a list of rates. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_38","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns rates list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/rates/2800\",
\"deleted\": false,
\"name\": \"Client Rate\",
\"description\": null,
\"id\": 2800
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Rates"],"summary":"Resource to create a new rate","operationId":"doPost_26","requestBody":{"description":"Minimum body:
{
\"name\": \"Rate VIP\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/RatePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/rates/{ID}":{"get":{"tags":["Rates"],"summary":"Resource to get a rate by ID.","operationId":"doGetById_35","parameters":[{"name":"ID","in":"path","description":"ID of rate","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a rate (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/rates/2800\",
\"deleted\": false,
\"name\": \"Client Rate\",
\"description\": null,
\"id\": 2800
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Rates"],"summary":"Resource to update an existing rate","operationId":"doPut_26","parameters":[{"name":"ID","in":"path","description":"ID of rate","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/RatePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Rates"],"summary":"Resource to delete an existing rate","operationId":"doDelete_23","parameters":[{"name":"ID","in":"path","description":"ID of rate","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/refundInvoiceReceipts/{ID}":{"get":{"tags":["RefundInvoiceReceipts"],"summary":"Resource to get a refund invoice receipt by ID.","operationId":"doGetById_36","parameters":[{"name":"ID","in":"path","description":"ID of refund invoice receipt","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a refund invoice receipt (if there are any result)
[{
\"utc-last-modification-date\": \"2025-01-21T10:44:19+0000\",
\"creator-id\": 1,
\"amount\": -20.68,
\"payment-option-id\": 11,
\"account-id\": 98,
\"settled\": false,
\"concept\": null,
\"currency-rate\": 1,
\"bank-account-id\": null,
\"payment-date\": null,
\"bank-account-path\": null,
\"account-path\": \"app.stelorder.com/app/clients/98\",
\"paid-employee-path\": null,
\"path\": \"app.stelorder.com/app/refundInvoiceReceipts/856861\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"original-element-path\": \"app.stelorder.com/app/refundInvoices/856862\",
\"original-element-id\": 856862,
\"paid-employee-id\": null,
\"paid\": false,
\"id\": 856861,
\"payment-term-date\": \"2025-01-14T00:00:00+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"full-reference\": \"RET00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["RefundInvoiceReceipts"],"summary":"Resource to update an existing refund invoice receipt","operationId":"doPut_27","parameters":[{"name":"ID","in":"path","description":"ID of refund invoice receipt","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/RefundInvoiceReceiptPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/refundInvoiceReceipts":{"get":{"tags":["RefundInvoiceReceipts"],"summary":"Resource to get a refund invoice receipt or a list of refund invoice receipts. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_39","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"concept","in":"query","description":"Filter clause (examples -> 'concept=foo', 'concept=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"amount","in":"query","description":"Filter clause (examples -> 'amount=30)
","schema":{"type":"number","format":"double"}},{"name":"paid","in":"query","description":"Filter clause (examples -> 'paid=true)'
","schema":{"type":"boolean"}},{"name":"payment-term-date","in":"query","description":"Filter clause (examples -> 'payment-term-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-payment-term-date","in":"query","description":"Filter all refund invoice receipts from payment-term-date (examples -> start-payment-term-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-payment-term-date","in":"query","description":"Filter all refund invoice receipts until payment-term-date (examples -> end-payment-term-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"payment-date","in":"query","description":"Filter clause (examples -> 'payment-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-payment-date","in":"query","description":"Filter All refund invoice receipts from payment-date (examples -> 'start-payment-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-payment-date","in":"query","description":"Filter All refund invoice receipts until payment-date (examples -> end-payment-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"settled","in":"query","description":"Filter clause (examples -> 'settled=true)'
","schema":{"type":"boolean"}},{"name":"original-element-id","in":"query","description":"Filter clause (examples -> 'original-element-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"paid-employee-id","in":"query","description":"Filter clause (examples -> 'paid-employee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"payment-option-id","in":"query","description":"Filter clause (examples -> 'payment-option-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"bank-account-id","in":"query","description":"Filter clause (examples -> 'bank-account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified refund invoice receipts from the date in UTC (examples -> 'utc-last-modification-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=concept', 'sort=concept:asc,full-reference:desc')
Sorting fields allowed: full-reference, concept, amount, paid, payment-term-date, payment-date, settled, original-element-id, account-id, creator-id, paid-employee-id, payment-option-id, bank-account-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns refund invoice receipts list (if there are any result)
[{
\"utc-last-modification-date\": \"2025-01-21T10:44:19+0000\",
\"creator-id\": 1,
\"amount\": -20.68,
\"payment-option-id\": 11,
\"account-id\": 98,
\"settled\": false,
\"concept\": null,
\"currency-rate\": 1,
\"bank-account-id\": null,
\"payment-date\": null,
\"bank-account-path\": null,
\"account-path\": \"app.stelorder.com/app/clients/98\",
\"paid-employee-path\": null,
\"path\": \"app.stelorder.com/app/refundInvoiceReceipts/856861\",
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"original-element-path\": \"app.stelorder.com/app/refundInvoices/856862\",
\"original-element-id\": 856862,
\"paid-employee-id\": null,
\"paid\": false,
\"id\": 856861,
\"payment-term-date\": \"2025-01-14T00:00:00+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"full-reference\": \"RET00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/refundInvoices":{"get":{"tags":["RefundInvoices"],"summary":"Resource to get a refund invoice or a list of refund invoices. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_40","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all refund invoices from the date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all refund invoices until the date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified refund invoices from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a refund invoices list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2019-06-24T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/95\",
\"discount-percentage\": 0,
\"total-amount\": -91.86,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/106\",
\"path\": \"app.stelorder.com/app/refundInvoices/3096173\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/54\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/ordinaryInvoices/60\",
\"addendum\": null,
\"id\": 3096173,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 86,
\"document-state-id\": 106,
\"serial-number-id\": 54,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"payment-option-id\": 14,
\"account-id\": 95,
\"settled\": false,
\"parent-document-id\": 60,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": -15.31,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"paid-total-amount\": 0,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"rate-id\": null,
\"creation-date\": \"2019-06-24T03:14:36+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/14\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": -76.55,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": -15.31
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/86\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/60\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": -2,
\"discount-percentage\": 0,
\"total-amount\": -24.2,
\"deleted\": false,
\"item-id\": 60,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Spice Variety\",
\"item-deleted\": false,
\"item-description\": \"Multiple spices imported from India.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 13476528,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 12.1
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/73\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": -1,
\"discount-percentage\": 0,
\"total-amount\": -10,
\"deleted\": false,
\"item-id\": 73,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Local Transport Service Costs\",
\"item-deleted\": false,
\"item-description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 13476527,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 10
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/67\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": -5,
\"discount-percentage\": 0,
\"total-amount\": -42.35,
\"deleted\": false,
\"item-id\": 67,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": Rose Cupcakes (5 units)\",
\"item-deleted\": false,
\"item-description\": \"Chocolate and vanilla cream filled cupcakes. Decorated with edible roses.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 13476529,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 8.47
}
],
\"sent-date\": null,
\"payment-terms-id\": 1,
\"payment-terms-path\": \"app.stelorder.com/app/paymentTerms/1\",
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": -76.55,
\"delivery-option-path\": null,
\"remaining-total-amount\": -91.86,
\"creator-id\": 1,
\"signature-name\": null,
\"parent-incident-path\": null,
\"receipts\": [
{
\"path\": \"app.stelorder.com/app/refundInvoiceReceipts/2085888\",
\"id\": 2085888
}
],
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"RET00001\",
\"currency-code\": \"USD\",
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["RefundInvoices"],"summary":"Resource to create a new refund invoice","operationId":"doPost_27","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/RefundInvoicePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/refundInvoices/{ID}":{"get":{"tags":["RefundInvoices"],"summary":"Resource to get a refund Invoice by ID.","operationId":"doGetById_37","parameters":[{"name":"ID","in":"path","description":"ID of refund Invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a refund Invoice (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2019-06-24T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/95\",
\"discount-percentage\": 0,
\"total-amount\": -91.86,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/106\",
\"path\": \"app.stelorder.com/app/refundInvoices/3096173\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/54\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/ordinaryInvoices/60\",
\"addendum\": null,
\"id\": 3096173,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 86,
\"document-state-id\": 106,
\"serial-number-id\": 54,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"payment-option-id\": 14,
\"account-id\": 95,
\"settled\": false,
\"parent-document-id\": 60,
\"income-tax-percentage\": 0,
\"signed\": false,
\"tax-total-amount\": -15.31,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"paid-total-amount\": 0,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"rate-id\": null,
\"creation-date\": \"2019-06-24T03:14:36+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/14\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": -76.55,
\"tax-percentage\": 20,
\"tax-name\": \"Sales Tax\",
\"type\": \"PRIMARY\",
\"total-amount\": -15.31
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/86\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/60\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": -2,
\"discount-percentage\": 0,
\"total-amount\": -24.2,
\"deleted\": false,
\"item-id\": 60,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Spice Variety\",
\"item-deleted\": false,
\"item-description\": \"Multiple spices imported from India.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 13476528,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 12.1
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/73\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": -1,
\"discount-percentage\": 0,
\"total-amount\": -10,
\"deleted\": false,
\"item-id\": 73,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Local Transport Service Costs\",
\"item-deleted\": false,
\"item-description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 13476527,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 10
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/67\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"units\": -5,
\"discount-percentage\": 0,
\"total-amount\": -42.35,
\"deleted\": false,
\"item-id\": 67,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": Rose Cupcakes (5 units)\",
\"item-deleted\": false,
\"item-description\": \"Chocolate and vanilla cream filled cupcakes. Decorated with edible roses.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 13476529,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 8.47
}
],
\"sent-date\": null,
\"payment-terms-id\": 1,
\"payment-terms-path\": \"app.stelorder.com/app/paymentTerms/1\",
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": -76.55,
\"delivery-option-path\": null,
\"remaining-total-amount\": -91.86,
\"creator-id\": 1,
\"signature-name\": null,
\"parent-incident-path\": null,
\"receipts\": [
{
\"path\": \"app.stelorder.com/app/refundInvoiceReceipts/2085888\",
\"id\": 2085888
}
],
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"RET00001\",
\"currency-code\": \"USD\",
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["RefundInvoices"],"summary":"Resource to update an existing refund invoice","operationId":"doPut_28","parameters":[{"name":"ID","in":"path","description":"ID of refund invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/RefundInvoicePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["RefundInvoices"],"summary":"Resource to delete an existing refund invoice","operationId":"doDelete_24","parameters":[{"name":"ID","in":"path","description":"ID of refund invoice","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/salesDeliveryNotes":{"get":{"tags":["SalesDeliveryNotes"],"summary":"Resource to get a sales delivery note or a list of sales delivery notes. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_41","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all sales delivery notes from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all sales delivery notes until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified sales delivery notes from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a sales delivery note list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": \"info@stelorder.com\",
\"bank-account-id\": 20,
\"parent-document-id\": null,
\"parent-document-path\": null,
\"account-path\": \"app.stelorder.com/app/clients/96\",
\"discount-percentage\": 0,
\"total-amount\": 363.6,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/82\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/53\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 54,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 88,
\"document-state-id\": 82,
\"serial-number-id\": 53,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 11,
\"account-id\": 96,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 60.6,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": \"app.stelorder.com/app/bankAccounts/20\",
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"creation-date\": \"2016-11-28T16:49:34+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [ {
\"subtotal-amount\": 303,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 60.6
}],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/88\",
\"email-sent-date\": \"2016-11-28T18:17:47+0000\",
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/71\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 3,
\"discount-percentage\": 0,
\"total-amount\": 105,
\"deleted\": false,
\"item-id\": 71,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"NC Thermostat\",
\"item-deleted\": false,
\"item-description\": \"It opens with an increase in temperature, from 0 to 60º C\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 227,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 35
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/75\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 6,
\"discount-percentage\": 0,
\"total-amount\": 198,
\"deleted\": false,
\"item-id\": 75,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Configuration Service Costs\",
\"item-deleted\": false,
\"item-description\": \"Your configuration services price, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 228,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 33
}
],
\"sent-date\": null,
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 303,
\"delivery-option-path\": null,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"SDN00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["SalesDeliveryNotes"],"summary":"Resource to create a new sales delivery note","operationId":"doPost_28","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SalesDeliveryNotePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/salesDeliveryNotes/{ID}":{"get":{"tags":["SalesDeliveryNotes"],"summary":"Resource to get a sales delivery note by ID.","operationId":"doGetById_38","parameters":[{"name":"ID","in":"path","description":"ID of sales delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a sales delivery note (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": \"info@stelorder.com\",
\"bank-account-id\": 20,
\"parent-document-id\": null,
\"parent-document-path\": null,
\"account-path\": \"app.stelorder.com/app/clients/96\",
\"discount-percentage\": 0,
\"total-amount\": 363.6,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/82\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/53\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 54,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 88,
\"document-state-id\": 82,
\"serial-number-id\": 53,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 11,
\"account-id\": 96,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 60.6,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": \"app.stelorder.com/app/bankAccounts/20\",
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"creation-date\": \"2016-11-28T16:49:34+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [ {
\"subtotal-amount\": 303,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 60.6
}],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/88\",
\"email-sent-date\": \"2016-11-28T18:17:47+0000\",
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/71\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 3,
\"discount-percentage\": 0,
\"total-amount\": 105,
\"deleted\": false,
\"item-id\": 71,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"NC Thermostat\",
\"item-deleted\": false,
\"item-description\": \"It opens with an increase in temperature, from 0 to 60º C\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 227,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 35
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/75\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 6,
\"discount-percentage\": 0,
\"total-amount\": 198,
\"deleted\": false,
\"item-id\": 75,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Configuration Service Costs\",
\"item-deleted\": false,
\"item-description\": \"Your configuration services price, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 228,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 33
}
],
\"sent-date\": null,
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 303,
\"delivery-option-path\": null,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"SDN00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["SalesDeliveryNotes"],"summary":"Resource to update an existing sales delivery note","operationId":"doPut_29","parameters":[{"name":"ID","in":"path","description":"ID of sales delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SalesDeliveryNotePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["SalesDeliveryNotes"],"summary":"Resource to delete an existing sales delivery note","operationId":"doDelete_25","parameters":[{"name":"ID","in":"path","description":"ID of sales delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/salesEstimates":{"get":{"tags":["SalesEstimates"],"summary":"Resource to get a sales estimate or a list of sales estimates. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_42","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all sales estimates from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all sales estimates until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified sales estimates from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a sales estimate list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2020-08-25T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": \"info@stelorder.com\",
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/80\",
\"discount-percentage\": 0,
\"total-amount\": 204,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/112\",
\"path\": \"app.stelorder.com/app/salesEstimates/42\",
\"private-comments\": \"You can insert internal comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/55\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 42,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 76,
\"document-state-id\": 112,
\"serial-number-id\": 55,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 11,
\"account-id\": 80,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 34,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"validity-date\": null,
\"creation-date\": \"2016-11-28T16:30:42+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 170,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 34
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/76\",
\"email-sent-date\": \"2016-11-28T16:55:35+0000\",
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/73\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 10,
\"deleted\": false,
\"item-id\": 73,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Local Transport Service Costs\",
\"item-deleted\": false,
\"item-description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 193,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 10
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/59\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 20,
\"discount-percentage\": 0,
\"total-amount\": 160,
\"deleted\": false,
\"item-id\": 59,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Industrial Polo Shirts\",
\"item-deleted\": false,
\"item-description\": \"Polo Shirts for different workplaces. They come in 7 colors (tones of blue and garnet). A company name or logo can be included.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 192,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 8
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 170,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"SE00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["SalesEstimates"],"summary":"Resource to create a new sales estimate","operationId":"doPost_29","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SalesEstimatePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/salesEstimates/{ID}":{"get":{"tags":["SalesEstimates"],"summary":"Resource to get a sales estimate by ID.","operationId":"doGetById_39","parameters":[{"name":"ID","in":"path","description":"ID of sales estimate","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a sales estimate (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": \"info@stelorder.com\",
\"bank-account-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/80\",
\"discount-percentage\": 0,
\"total-amount\": 204,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/112\",
\"path\": \"app.stelorder.com/app/salesEstimates/42\",
\"private-comments\": \"You can insert internal comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/55\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 42,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 76,
\"document-state-id\": 112,
\"serial-number-id\": 55,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 11,
\"account-id\": 80,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 34,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"validity-date\": null,
\"creation-date\": \"2016-11-28T16:30:42+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 170,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 34
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/76\",
\"email-sent-date\": \"2016-11-28T16:55:35+0000\",
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/73\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 10,
\"deleted\": false,
\"item-id\": 73,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Local Transport Service Costs\",
\"item-deleted\": false,
\"item-description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 193,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 10
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/59\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 20,
\"discount-percentage\": 0,
\"total-amount\": 160,
\"deleted\": false,
\"item-id\": 59,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Industrial Polo Shirts\",
\"item-deleted\": false,
\"item-description\": \"Polo Shirts for different workplaces. They come in 7 colors (tones of blue and garnet). A company name or logo can be included.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 192,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 8
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 170,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"SE00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["SalesEstimates"],"summary":"Resource to update an existing sales estimate","operationId":"doPut_30","parameters":[{"name":"ID","in":"path","description":"ID of sales estimate","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SalesEstimatePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["SalesEstimates"],"summary":"Resource to delete an existing sales estimate","operationId":"doDelete_26","parameters":[{"name":"ID","in":"path","description":"ID of sales estimate","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/salesOrders":{"get":{"tags":["SalesOrders"],"summary":"Resource to get a sales order or a list of sales orders. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_43","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all sales orders from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all sales orders until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified sales orders from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a sales order list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": \"info@stelorder.com\",
\"bank-account-id\": null,
\"parent-document-id\": null,
\"parent-document-path\": null,
\"account-path\": \"app.stelorder.com/app/clients/87\",
\"discount-percentage\": 0,
\"total-amount\": 224.4,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/81\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/43\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 49,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 77,
\"document-state-id\": 81,
\"serial-number-id\": 43,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 11,
\"account-id\": 87,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 37.4,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"creation-date\": \"2016-11-28T16:44:45+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 187,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 37.4
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/77\",
\"email-sent-date\": \"2016-11-28T16:55:47+0000\",
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/58\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 5,
\"discount-percentage\": 0,
\"total-amount\": 94,
\"deleted\": false,
\"item-id\": 58,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Folders (6 Pack)\",
\"item-deleted\": false,
\"item-description\": \"A safe and comfortable way to store documents and other office items\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 212,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 18.8
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/66\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 35,
\"deleted\": false,
\"item-id\": 66,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Paper Cutter\",
\"item-deleted\": false,
\"item-description\": \"Useful for offices that handle large amounts of paperwork.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 213,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 35
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/63\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 58,
\"deleted\": false,
\"item-id\": 63,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Storage Box (Plastic)\",
\"item-deleted\": false,
\"item-description\": \"Plastic boxes designed for offices, worshops and more. Very useful to store documents and tools as well as keeping them close and safe.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 214,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 29
}
],
\"sent-date\": null,
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 187,
\"delivery-option-path\": null,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"SO00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["SalesOrders"],"summary":"Resource to create a new sales order","operationId":"doPost_30","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SalesOrderPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/salesOrders/{ID}":{"get":{"tags":["SalesOrders"],"summary":"Resource to get a sales order by ID.","operationId":"doGetById_40","parameters":[{"name":"ID","in":"path","description":"ID of sales order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a sales order (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": \"info@stelorder.com\",
\"bank-account-id\": null,
\"parent-document-id\": null,
\"parent-document-path\": null,
\"account-path\": \"app.stelorder.com/app/clients/87\",
\"discount-percentage\": 0,
\"total-amount\": 224.4,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/81\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/43\",
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 49,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 77,
\"document-state-id\": 81,
\"serial-number-id\": 43,
\"email-read-count\": 0,
\"delivery-address-id\": null,
\"payment-option-id\": 11,
\"account-id\": 87,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 37.4,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"delivery-address-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"rate-id\": null,
\"creation-date\": \"2016-11-28T16:44:45+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 187,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 37.4
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/77\",
\"email-sent-date\": \"2016-11-28T16:55:47+0000\",
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/58\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 5,
\"discount-percentage\": 0,
\"total-amount\": 94,
\"deleted\": false,
\"item-id\": 58,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Folders (6 Pack)\",
\"item-deleted\": false,
\"item-description\": \"A safe and comfortable way to store documents and other office items\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 212,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 18.8
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/66\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 35,
\"deleted\": false,
\"item-id\": 66,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Paper Cutter\",
\"item-deleted\": false,
\"item-description\": \"Useful for offices that handle large amounts of paperwork.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 213,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 35
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/63\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 58,
\"deleted\": false,
\"item-id\": 63,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Storage Box (Plastic)\",
\"item-deleted\": false,
\"item-description\": \"Plastic boxes designed for offices, worshops and more. Very useful to store documents and tools as well as keeping them close and safe.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 214,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 29
}
],
\"sent-date\": null,
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 187,
\"delivery-option-path\": null,
\"signature-name\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"SO00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["SalesOrders"],"summary":"Resource to update an existing sales order","operationId":"doPut_31","parameters":[{"name":"ID","in":"path","description":"ID of sales order","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SalesOrderPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["SalesOrders"],"summary":"Resource to delete an existing sales order","operationId":"doDelete_27","parameters":[{"name":"ID","in":"path","description":"ID of sales order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/sendDocument/{ID}":{"put":{"tags":["SendDocument"],"summary":"Resource to send a document by email","operationId":"doPut_32","parameters":[{"name":"ID","in":"path","description":"ID of Document","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SendDocumentPut"}}}},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/serialNumbers/{ID}":{"get":{"tags":["SerialNumbers"],"summary":"Resource to get a serial number by ID.","operationId":"doGetById_41","parameters":[{"name":"ID","in":"path","description":"ID of serial number","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a serial number (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/serialNumbers/52\",
\"default\": true,
\"deleted\": false,
\"number-of-digits\": 5,
\"prefix\": \"PRO\",
\"name\": \"Product\",
\"id\": 52,
\"last-reference\": 19,
\"type\": \"PRODUCT\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/serialNumbers":{"get":{"tags":["SerialNumbers"],"summary":"Resource to get a serial number or a list of serial numbers. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_44","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter clause (examples -> 'type=ORDINARYINVOICE')
","schema":{"type":"string","enum":["PRODUCT","SERVICE","EXPENSEANDINVESTMENT","ASSET","CLIENT","POTENTIALCLIENT","SUPPLIER","INCIDENT","SALESESTIMATE","SALESORDER","SALESDELIVERYNOTE","WORKESTIMATE","WORKORDER","WORKDELIVERYNOTE","ORDINARYINVOICE","REFUNDINVOICE","PURCHASEORDER","PURCHASEDELIVERYNOTE","PURCHASEINVOICE","EXPENSE","STOCKTRANSFER"]}},{"name":"prefix","in":"query","description":"Filter clause (examples -> 'prefix=foo', 'prefix=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"last-reference","in":"query","description":"Filter clause (examples -> 'last-reference=30')
","schema":{"type":"integer","format":"int64"}},{"name":"number-of-digits","in":"query","description":"Filter clause (examples -> 'number-of-digits=5')
","schema":{"type":"integer","format":"int64"}},{"name":"default","in":"query","description":"Filter clause (examples -> 'default=true')
","schema":{"type":"boolean"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,prefix:desc')
Sorting fields allowed: name, prefix, last-reference, number-of-digits, default, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns serial numbers list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/serialNumbers/52\",
\"default\": true,
\"deleted\": false,
\"number-of-digits\": 5,
\"prefix\": \"PRO\",
\"name\": \"Product\",
\"id\": 52,
\"last-reference\": 19,
\"type\": \"PRODUCT\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/services":{"get":{"tags":["Services"],"summary":"Resource to get a service or a list of services. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_45","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"private-comments","in":"query","description":"Filter clause (examples -> 'private-comments=foo', 'private-comments=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=name:asc,reference:desc')
Sorting fields allowed: full-reference, reference, name, description, private-comments, creation-date, external-id, serial-number-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a services list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"primary-tax-percentage\": 10,
\"description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"discount-percentage\": 0,
\"reference\": \"00004\",
\"path\": \"app.stelorder.com/app/services/73\",
\"private-comments\": null,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/50\",
\"inactive\": false,
\"sales-price\": 10,
\"sales-minimum-price\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/37273\",
\"external-id\": null,
\"id\": 73,
\"purchase-price\": 7,
\"promotional\": false,
\"serial-number-id\": 50,
\"item-rates\": [
{
\"rate-path\": \"app.stelorder.com/app/rates/2807\",
\"rate-id\": 2807,
\"price\": 9
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2808\",
\"rate-id\": 2808,
\"price\": 8
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2808\",
\"rate-id\": 2808,
\"price\": 7
}
],
\"sales-countable-account\": null,
\"purchase-margin-percentage\": 42.86,
\"deleted\": false,
\"secondary-tax-percentage\": 0,
\"item-images\": [
{
\"item-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"name\": \"Local Transport Service Costs\",
\"creation-date\": \"2016-11-28T13:05:44+0000\",
\"sales-margin-percentage\": 30,
\"purchase-countable-account\": null,
\"primary-tax-id\": 37273,
\"full-reference\": \"SER00004\",
\"margin-enabled\": false
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Services"],"summary":"Resource to create a new service","operationId":"doPost_31","requestBody":{"description":"Minimum body:
{
\"name\": \"Local Transport Service Costs\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServicePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/services/{ID}":{"get":{"tags":["Services"],"summary":"Resource to get a service by ID.","operationId":"doGetById_42","parameters":[{"name":"ID","in":"path","description":"ID of service","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a service (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"primary-tax-percentage\": 10,
\"description\": \"In case you need make your deliveries yourself and charge extra for transporting goods and services.\",
\"discount-percentage\": 0,
\"reference\": \"00004\",
\"path\": \"app.stelorder.com/app/services/73\",
\"private-comments\": null,
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/50\",
\"inactive\": false,
\"sales-price\": 10,
\"sales-minimum-price\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/37273\",
\"external-id\": null,
\"id\": 73,
\"purchase-price\": 7,
\"promotional\": false,
\"serial-number-id\": 50,
\"item-rates\": [
{
\"rate-path\": \"app.stelorder.com/app/rates/2807\",
\"rate-id\": 2807,
\"price\": 9
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2808\",
\"rate-id\": 2808,
\"price\": 8
},
{
\"rate-path\": \"app.stelorder.com/app/rates/2809\",
\"rate-id\": 2809,
\"price\": 7
}
],
\"sales-countable-account\": null,
\"purchase-margin-percentage\": 42.86,
\"deleted\": false,
\"secondary-tax-percentage\": 0,
\"item-images\": [
{
\"item-image-path\": \"https://app.stelorder.com/app/ControladorPublico?token=AEcihxapBKwKQQTDK1j9PE5Xi-o7EqqCB1H4-7ML2EbqA-cRK5UWRYc0Om6nKOyfMKAH9G0M5Q2_PhCxhYguhuDlXK8G4RWQwOq6tIbGL-XF_TMrzpxyAQRLnCvZ8MiH9YsGHImV32PZQ1f8oDRwIssB5IXqHKIpX0gqxH9cbhwDX7AStizg8igSb7BPP6WvYf2zTwb2cVDj\",
\"order\": 0
}
],
\"name\": \"Local Transport Service Costs\",
\"creation-date\": \"2016-11-28T13:05:44+0000\",
\"sales-margin-percentage\": 30,
\"purchase-countable-account\": null,
\"primary-tax-id\": 37273,
\"full-reference\": \"SER00004\",
\"margin-enabled\": false
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Services"],"summary":"Resource to update an existing service","operationId":"doPut_33","parameters":[{"name":"ID","in":"path","description":"ID of service","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServicePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Services"],"summary":"Resource to delete an existing service","operationId":"doDelete_28","parameters":[{"name":"ID","in":"path","description":"ID of service","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/shopItems":{"get":{"tags":["ShopItems"],"summary":"Resource to get a shop item or a list of shop items. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_46","parameters":[{"name":"product-slug","in":"query","description":"Filter clause (examples -> 'product-slug=foo', 'product-slug=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"shop-name","in":"query","description":"Filter clause (examples -> 'shop-name=foo', 'shop-name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"shop-description","in":"query","description":"Filter clause (examples -> 'shop-description=foo', 'shop-description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"detailed-description","in":"query","description":"Filter clause (examples -> 'detailed-description=foo', 'detailed-description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"show-in-shop","in":"query","description":"Filter clause (examples -> 'show-in-shop=true')
","schema":{"type":"boolean"}},{"name":"shop-visibility","in":"query","description":"Filter clause (examples -> 'shop-visibility=PRIVATE_PUBLIC')
","schema":{"type":"string","enum":["PRIVATE","PRIVATE_PUBLIC","PUBLIC"]}},{"name":"featured","in":"query","description":"Filter clause (examples -> 'featured=true')
","schema":{"type":"boolean"}},{"name":"seo-title","in":"query","description":"Filter clause (examples -> 'seo-title=foo', 'seo-title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"seo-description","in":"query","description":"Filter clause (examples -> 'seo-description=foo', 'seo-description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"item-id","in":"query","description":"Filter clause (examples -> 'item-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=product-slug', 'sort=product-slug:asc,shop-name:desc')
Sorting fields allowed: product-slug, shop-name, shop-description, detailed-description, seo-title, seo-description, publishing-date, item-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a shop items list (if there are any result)
[{
\"path\": \"app.stelorder.com/app/shopItems/162013\",
\"item-path\": \"app.stelorder.com/app/products/14821657\",
\"deleted\": false,
\"item-id\": 14821657,
\"id\": 59018,
\"featured\": false,
\"show-in-shop\": true,
\"seo-title\": \"\",
\"seo-description\": \"\",
\"detailed-description\": \"\",
\"shop-visibility\": \"PRIVATE_PUBLIC\",
\"shop-name\": \"Shop Product\",
\"product-slug\": \"shop-product\",
\"publishing-date\": \"2021-09-24T06:11:08+0000\",
\"utc-last-modification-date\": \"2021-09-24T06:11:08+0000\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/specialPrices":{"get":{"tags":["SpecialPrices"],"summary":"Resource to get a special price or a list of special prices. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_47","parameters":[{"name":"item-id","in":"query","description":"Filter clause (examples -> 'item-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=item-id', 'sort=item-id:asc,item-id:desc')
Sorting fields allowed: item-id, account-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns special prices list (if there are any result)
[{
\"path\": \"app.stelorder.com/app/specialPrices/162013\",
\"item-path\": \"app.stelorder.com/app/products/14821657\",
\"deleted\": false,
\"item-id\": 14821657,
\"account-id\": 5457491,
\"price\": \"0.0\",
\"item-supplier-reference\": null,
\"id\": 162013,
\"utc-last-modification-date\": \"2021-09-24T06:11:08+0000\",
\"currency-code\": \"EUR\",
\"account-path\": \"app.stelorder.com/app/clients/5457491\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["SpecialPrices"],"summary":"Resource to upload a special price","operationId":"doPost_32","requestBody":{"description":"Minimum body:
{
\"item-id\": 6852295,
\"account-id\": 2414,
\"price\": 0
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SpecialPricePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/specialPrices/{ID}":{"get":{"tags":["SpecialPrices"],"summary":"Resource to get a special price by ID.","operationId":"doGetById_43","parameters":[{"name":"ID","in":"path","description":"ID of special price","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a special price (if there are any result)
[{
\"path\": \"app.stelorder.com/app/specialPrices/162013\",
\"item-path\": \"app.stelorder.com/app/products/14821657\",
\"deleted\": false,
\"item-id\": 14821657,
\"account-id\": 5457491,
\"price\": \"0.0\",
\"item-supplier-reference\": null,
\"id\": 162013,
\"utc-last-modification-date\": \"2021-09-24T06:11:08+0000\",
\"currency-code\": \"EUR\",
\"account-path\": \"app.stelorder.com/app/clients/5457491\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["SpecialPrices"],"summary":"Resource to update an existing special price","operationId":"doPut_34","parameters":[{"name":"ID","in":"path","description":"ID of special price","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SpecialPricePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["SpecialPrices"],"summary":"Resource to delete an existing special price","operationId":"doDelete_29","parameters":[{"name":"ID","in":"path","description":"ID of special price","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/stockMovements":{"get":{"tags":["StockMovements"],"summary":"Resource to get a stock movement or a list of stock movements. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_48","parameters":[{"name":"type","in":"query","description":"Filter clause (examples -> 'type=PRODUCTCREATION')
","schema":{"type":"string","enum":["PRODUCTCREATION","PRODUCTEDIT","PRODUCTEDITAPI","DOCUMENTCREATION","DOCUMENTEDIT","DOCUMENTDELETE","MULTIPLEINVOICECREATION","MULTIPLEINVOICEDELETE","STOCKTRANSFERCREATION","STOCKTRANSFEREDIT","STOCKTRANSFERDELETE"]}},{"name":"item-id","in":"query","description":"Filter clause (examples -> 'item-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"warehouse-id","in":"query","description":"Filter clause (examples -> 'warehouse-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"source-warehouse-id","in":"query","description":"Filter clause (examples -> 'source-warehouse-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"destination-warehouse-id","in":"query","description":"Filter clause (examples -> 'destination-warehouse-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"employee-id","in":"query","description":"Filter clause (examples -> 'employee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=date', 'sort=date:asc,item-id:desc')
Sorting fields allowed: date, real-stock-previous, real-stock-movement, real-stock-result, item-id, warehouse-id, source-warehouse-id, destination-warehouse-id, employee-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a stock movements items list (if there are any result)
[{
\"date\": \"2023-04-24T16:15:39+0000\",
\"employee-id\": 1,
\"item-path\": \"app.stelorder.com/app/products/20914091\",
\"warehouse-id\": -2,
\"stock-transfer-path\": null,
\"utc-last-modification-date\": \"2023-04-24T14:15:38+0000\",
\"real-stock-result\": 1,
\"type\": \"PRODUCTCREATION\",
\"real-stock-previous\": 0,
\"employee-path\": \"app.stelorder.com/app/employees/1\",
\"deleted\": false,
\"item-id\": 20914091,
\"stock-transfer-id\": null,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"source-warehouse-id\": null,
\"source-warehouse-path\": null,
\"destination-warehouse-id\": -2,
\"destination-warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"real-stock-movement\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/suppliers":{"get":{"tags":["Suppliers"],"summary":"Resource to get a supplier or a list of suppliers. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_49","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"legal-name","in":"query","description":"Filter clause (examples -> 'legal-name=foo', 'legal-name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"tax-identification-number","in":"query","description":"Filter clause (examples -> 'tax-identification-number=foo', 'tax-identification-number=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter clause (examples -> 'email=foo', 'email=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Filter clause (examples -> 'phone=612345678', 'phone=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"phone2","in":"query","description":"Filter clause (examples -> 'phone2=612345678', 'phone2=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"fax","in":"query","description":"Filter clause (examples -> 'fax=612345678', 'fax=in:612345678,687654321' (like OR clause))
","schema":{"type":"string"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-category-id","in":"query","description":"Filter clause (examples -> 'account-category-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=account-category-id:asc,name:asc,reference:desc')
Sorting fields allowed: full-reference, reference, legal-name, name, tax-identification-number, email, phone, phone2, fax, creation-date, external-id, serial-number-id, account-category-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a suppliers list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"supplier-category-path\": \"app/supplierCategories/5\",
\"phone2\": null,
\"payment-day\": null,
\"special-prices\": [
{
\"item-path\": \"app.stelorder.com/app/services/6852234\",
\"item-id\": 6852234,
\"price\": 6
},
{
\"item-path\": \"app.stelorder.com/app/products/6852296\",
\"item-id\": 6852296,
\"price\": 100
}
],
\"discount-percentage\": 0,
\"supplier-category-id\": 5,
\"identification-number\": \"B99999999\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"phone\": \"96666666\",
\"reference\": \"000002\",
\"path\": \"app/suppliers/68\",
\"primary-tax-enabled\": true,
\"serial-number-path\": \"app/serialNumbers/30\",
\"rate-path\": null,
\"legal-name\": \"Peter of the sticks\",
\"currency\": \"EUR\",
\"id\": 68,
\"fax\": null,
\"income-tax-enabled\": false,
\"email\": \"info@info.com\",
\"main-address\": {
\"country-code\": \"ES\",
\"address-type-name\": \"Default\",
\"city-town\": \"Toledo\",
\"extra-data\": null,
\"path\": \"app/addresses/55\",
\"account-path\": \"app/suppliers/68\",
\"account-id\": 68,
\"latitude\": 1.33,
\"longitude\": -2.55,
\"postal-code\": \"45004\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"province\": \"Toledo\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"name\": \"Default address\",
\"id\": 55,
\"formatted-address\": \"Paseo Cristo de la Vega, 12\",
\"address-data\": \"Paseo Cristo de la Vega, 12\"
},
\"bank-account\": {
\"deleted\": false,
\"account-id\": 68,
\"name\": null,
\"description\": null,
\"utc-last-modification-date\": \"2023-03-13T10:06:58+0000\",
\"account\": \"21218617\",
\"account-path\": \"app.stelorder.com/app/suppliers/68\",
\"bic-swift\": null
},
\"payment-terms-id\": null,
\"payment-terms-path\": null,
\"agent-id\": null,
\"website\": \"www.petersticks.com\",
\"serial-number-id\": 30,
\"comments\": null,
\"payment-option-id\": null,
\"countable-account\": null,
\"secondary-tax-enabled\": false,
\"payment-adjustment\": null,
\"agent-path\": null,
\"deleted\": false,
\"rate-id\": null,
\"name\": \"Peter sticks\",
\"creation-date\": \"25/07/2016 13:16:28\",
\"currency-position\": \"RIGHT\",
\"payment-option-path\": null,
\"full-reference\": \"CLI000002\",
\"currency-code\": \"EUR\",
\"currency-symbol\": \"€\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["Suppliers"],"summary":"Resource to create a new supplier","operationId":"doPost_33","requestBody":{"description":"Minimum body:
{
\"legal-name\": \"John\"
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SupplierPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/suppliers/{ID}":{"get":{"tags":["Suppliers"],"summary":"Resource to get a supplier by ID.","operationId":"doGetById_44","parameters":[{"name":"ID","in":"path","description":"ID of supplier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a supplier (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"supplier-category-path\": \"app/supplierCategories/5\",
\"phone2\": null,
\"payment-day\": null,
\"special-prices\": [
{
\"item-path\": \"app.stelorder.com/app/services/6852234\",
\"item-id\": 6852234,
\"price\": 6
},
{
\"item-path\": \"app.stelorder.com/app/products/6852296\",
\"item-id\": 6852296,
\"price\": 100
}
],
\"discount-percentage\": 0,
\"supplier-category-id\": 5,
\"identification-number\": \"B99999999\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"phone\": \"96666666\",
\"reference\": \"000002\",
\"path\": \"app/suppliers/68\",
\"primary-tax-enabled\": true,
\"serial-number-path\": \"app/serialNumbers/30\",
\"rate-path\": null,
\"legal-name\": \"Peter of the sticks\",
\"currency\": \"EUR\",
\"id\": 68,
\"fax\": null,
\"income-tax-enabled\": false,
\"email\": \"info@info.com\",
\"main-address\": {
\"country-code\": \"ES\",
\"address-type-name\": \"Default\",
\"city-town\": \"Toledo\",
\"extra-data\": null,
\"path\": \"app/addresses/55\",
\"account-path\": \"app/suppliers/68\",
\"account-id\": 68,
\"latitude\": 1.33,
\"longitude\": -2.55,
\"postal-code\": \"45004\",
\"deleted\": false,
\"address-type\": \"DEFAULT\",
\"province\": \"Toledo\",
\"external-id\": \"123e4567-e89b-12d3-a456-426655440000\",
\"name\": \"Default address\",
\"id\": 55,
\"formatted-address\": \"Paseo Cristo de la Vega, 12\",
\"address-data\": \"Paseo Cristo de la Vega, 12\"
},
\"bank-account\": {
\"deleted\": false,
\"account-id\": 68,
\"name\": null,
\"description\": null,
\"utc-last-modification-date\": \"2023-03-13T10:06:58+0000\",
\"account\": \"21218617\",
\"account-path\": \"app.stelorder.com/app/suppliers/68\",
\"bic-swift\": null
},
\"payment-terms-id\": null,
\"payment-terms-path\": null,
\"agent-id\": null,
\"website\": \"www.petersticks.com\",
\"serial-number-id\": 30,
\"comments\": null,
\"payment-option-id\": null,
\"countable-account\": null,
\"secondary-tax-enabled\": false,
\"payment-adjustment\": null,
\"agent-path\": null,
\"deleted\": false,
\"rate-id\": null,
\"name\": \"Peter sticks\",
\"creation-date\": \"25/07/2016 13:16:28\",
\"currency-position\": \"RIGHT\",
\"payment-option-path\": null,
\"full-reference\": \"CLI000002\",
\"currency-code\": \"EUR\",
\"currency-symbol\": \"€\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["Suppliers"],"summary":"Resource to update an existing supplier","operationId":"doPut_35","parameters":[{"name":"ID","in":"path","description":"ID of supplier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/SupplierPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["Suppliers"],"summary":"Resource to delete an existing supplier","operationId":"doDelete_30","parameters":[{"name":"ID","in":"path","description":"ID of supplier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/taxLines/{ID}":{"get":{"tags":["TaxLines"],"summary":"Resource to get a tax line by ID.","operationId":"doGetById_45","parameters":[{"name":"ID","in":"path","description":"ID of tax line","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a tax line (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/taxLines/37273\",
\"default\": true,
\"deleted\": false,
\"tax-percentage\": 10,
\"tax-name\": \"Sales Tax\",
\"id\": 37273,
\"type\": \"CONSUMPTION\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/taxLines":{"get":{"tags":["TaxLines"],"summary":"Resource to get a tax line or a list of tax lines. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_50","parameters":[{"name":"tax-name","in":"query","description":"Filter clause (examples -> 'tax-name=foo', 'tax-name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter clause (examples -> 'type=CONSUMPTION')
","schema":{"type":"string","enum":["CONSUMPTION","INCOME"]}},{"name":"tax-percentage","in":"query","description":"Filter clause (examples -> 'tax-percentage=30)
","schema":{"type":"number","format":"double"}},{"name":"default","in":"query","description":"Filter clause (examples -> 'default=true')
","schema":{"type":"boolean"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=tax-percentage', 'sort=tax-percentage:asc,default:desc')
Sorting fields allowed:
tax-name, tax-percentage, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns tax lines list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/taxLines/37273\",
\"default\": true,
\"deleted\": false,
\"tax-percentage\": 10,
\"tax-name\": \"Sales Tax\",
\"id\": 37273,
\"type\": \"CONSUMPTION\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/tempoEmployees/{ID}":{"get":{"tags":["TempoEmployees"],"summary":"Resource to get an tempoEmployee by ID.","operationId":"doGetById_46","parameters":[{"name":"ID","in":"path","description":"ID of tempoEmployee","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns an tempoEmployee (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/tempoEmployees/1\",
\"deleted\": false,
\"user-name\": \"user@stelorder.com\",
\"tax-identification-number\": null,
\"phone\": null,
\"name\": null,
\"surname\": null,
\"phone2\": null,
\"creation-date\": \"2017-02-14T16:00:51+0000\",
\"tempoEmployee-role-id\": -2,
\"tempoEmployee-role-path\": \"app.stelorder.com/app/employeeRoles/-2\",
\"id\": 1,
\"position\": null,
\"email\": \"user@stelorder.com\"
\"allday-absence\": false
\"absence-type-name\": false
\"absence-type-description\": false
\"tempo-status\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/tempoEmployees":{"get":{"tags":["TempoEmployees"],"summary":"Resource to get an tempoEmployee or a list of tempoEmployees. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_51","parameters":[{"name":"user-name","in":"query","description":"Filter clause (examples -> 'user-name=foo', 'user-name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"surname","in":"query","description":"Filter clause (examples -> 'surname=foo', 'surname=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"tax-identification-number","in":"query","description":"Filter clause (examples -> 'tax-identification-number=foo', 'tax-identification-number=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Filter clause (examples -> 'phone=foo', 'phone=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"phone2","in":"query","description":"Filter clause (examples -> 'phone2=foo', 'phone2=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter clause (examples -> 'email=foo', 'email=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"position","in":"query","description":"Filter clause (examples -> 'position=foo', 'position=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"employee-role-id","in":"query","description":"Filter clause (example -> 'employee-role-id=1')
","schema":{"type":"string"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,email:desc')
Sorting fields allowed: user-name, name, surname, tax-identification-number, phone, phone2, email, position, creation-date, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns tempoEmployee list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"path\": \"app.stelorder.com/app/tempoEmployees/1\",
\"deleted\": false,
\"user-name\": \"user@stelorder.com\",
\"tax-identification-number\": null,
\"phone\": null,
\"name\": null,
\"surname\": null,
\"phone2\": null,
\"creation-date\": \"2017-02-14T16:00:51+0000\",
\"tempoEmployee-role-id\": -2,
\"tempoEmployee-role-path\": \"app.stelorder.com/app/employeeRoles/-2\",
\"id\": 1,
\"position\": null,
\"email\": \"user@stelorder.com\"
\"allday-absence\": false
\"absence-type-name\": false
\"absence-type-description\": false
\"tempo-status\": 1
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/warehouses/{ID}":{"get":{"tags":["Warehouses"],"summary":"Resource to get a warehouse by ID.","operationId":"doGetById_47","parameters":[{"name":"ID","in":"path","description":"ID of warehouse","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a warehouse (if there are any result)
[{
\"path\": \"app.stelorder.com/app/warehouses/-2\",
\"deleted\": false,
\"hidden\": false,
\"public\": true,
\"name\": \"Main Warehouse\",
\"description\": null,
\"id\": -2,
\"utc-last-modification-date\": \"2020-10-09T07:01:26+0000\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/warehouses":{"get":{"tags":["Warehouses"],"summary":"Resource to get a warehouse or a list of warehouses. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_52","parameters":[{"name":"name","in":"query","description":"Filter clause (examples -> 'name=foo', 'name=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter clause (examples -> 'description=foo', 'description=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"hidden","in":"query","description":"Filter clause (examples -> 'hidden=true')
","schema":{"type":"boolean"}},{"name":"public","in":"query","description":"Filter clause (examples -> 'public=true')
","schema":{"type":"boolean"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2019-06-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=name', 'sort=name:asc,description:desc')
Sorting fields allowed: name, description, hidden, public, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns warehouses list (if there are any result)
[{
\"path\": \"app.stelorder.com/app/warehouses/-2\",
\"deleted\": false,
\"hidden\": false,
\"public\": true,
\"name\": \"Main Warehouse\",
\"description\": null,
\"id\": -2,
\"utc-last-modification-date\": \"2020-10-09T07:01:26+0000\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/workDeliveryNotes":{"get":{"tags":["WorkDeliveryNotes"],"summary":"Resource to get a work delivery note or a list of work delivery notes. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_53","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all work delivery notes from the date (examples -> 'start-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all work delivery notes until the date (examples -> 'end-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all work delivery notes from the date in UTC (examples -> 'utc-last-modification-date=2025-01-25T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a work delivery note list (if there are any result)
[{
\"utc-last-modification-date\": \"2025-01-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": 19,
\"account-path\": \"app.stelorder.com/app/clients/87\",
\"discount-percentage\": 0,
\"total-amount\": 178.8,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/85\",
\"path\": \"app.stelorder.com/app/workDeliveryNotes/69\",
\"private-comments\": \"Configure internet connection and network\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/59\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/workOrders/68\",
\"addendum\": null,
\"id\": 69,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 77,
\"document-state-id\": 85,
\"serial-number-id\": 59,
\"email-read-count\": 0,
\"payment-option-id\": 11,
\"account-id\": 87,
\"settled\": false,
\"parent-document-id\": 68,
\"signed\": false,
\"tax-total-amount\": 29.8,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": \"app.stelorder.com/app/bankAccounts/19\",
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"work-address-id\": null,
\"rate-id\": null,
\"creation-date\": \"2016-11-28T18:13:35+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"work-address-path\": null,
\"invoice-to-account-id\": null,
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"start-date\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 149,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 29.8
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/77\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"due-date\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/76\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 50,
\"deleted\": false,
\"item-id\": 76,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Labor Costs (30 min.)\",
\"item-deleted\": false,
\"item-description\": \"Your labor costs every 30 minutes, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 269,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 25
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/75\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 3,
\"discount-percentage\": 0,
\"total-amount\": 99,
\"deleted\": false,
\"item-id\": 75,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Configuration Service Costs\",
\"item-deleted\": false,
\"item-description\": \"Your configuration services price, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 270,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 33
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 149,
\"delivery-option-path\": null,
\"signature-name\": null,
\"parent-incident-path\": null,
\"invoice-to-account-path\": null,
\"end-date\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"WDN00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["WorkDeliveryNotes"],"summary":"Resource to create a new work delivery note","operationId":"doPost_34","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/WorkDeliveryNotePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/workDeliveryNotes/{ID}":{"get":{"tags":["WorkDeliveryNotes"],"summary":"Resource to get a work delivery note by ID.","operationId":"doGetById_48","parameters":[{"name":"ID","in":"path","description":"ID of work delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a work delivery note (if there are any result)
[{
\"utc-last-modification-date\": \"2025-01-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": 19,
\"account-path\": \"app.stelorder.com/app/clients/87\",
\"discount-percentage\": 0,
\"total-amount\": 178.8,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/85\",
\"path\": \"app.stelorder.com/app/workDeliveryNotes/69\",
\"private-comments\": \"Configure internet connection and network\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/59\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": \"app.stelorder.com/app/workOrders/68\",
\"addendum\": null,
\"id\": 69,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 77,
\"document-state-id\": 85,
\"serial-number-id\": 59,
\"email-read-count\": 0,
\"payment-option-id\": 11,
\"account-id\": 87,
\"settled\": false,
\"parent-document-id\": 68,
\"signed\": false,
\"tax-total-amount\": 29.8,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": \"app.stelorder.com/app/bankAccounts/19\",
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"work-address-id\": null,
\"rate-id\": null,
\"creation-date\": \"2016-11-28T18:13:35+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"work-address-path\": null,
\"invoice-to-account-id\": null,
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"start-date\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 149,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 29.8
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/77\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"due-date\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/76\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 50,
\"deleted\": false,
\"item-id\": 76,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Labor Costs (30 min.)\",
\"item-deleted\": false,
\"item-description\": \"Your labor costs every 30 minutes, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 269,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 25
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/75\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 3,
\"discount-percentage\": 0,
\"total-amount\": 99,
\"deleted\": false,
\"item-id\": 75,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Configuration Service Costs\",
\"item-deleted\": false,
\"item-description\": \"Your configuration services price, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 270,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 33
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 149,
\"delivery-option-path\": null,
\"signature-name\": null,
\"parent-incident-path\": null,
\"invoice-to-account-path\": null,
\"end-date\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"WDN00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["WorkDeliveryNotes"],"summary":"Resource to update an existing work delivery note","operationId":"doPut_36","parameters":[{"name":"ID","in":"path","description":"ID of work delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/WorkDeliveryNotePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["WorkDeliveryNotes"],"summary":"Resource to delete an existing work delivery note","operationId":"doDelete_31","parameters":[{"name":"ID","in":"path","description":"ID of work delivery note","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/workEstimates":{"get":{"tags":["WorkEstimates"],"summary":"Resource to get a work estimate or a list of work estimates. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_54","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all work estimates from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all work estimates until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified entities from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a work estimate list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": 20,
\"account-path\": \"app.stelorder.com/app/clients/83\",
\"discount-percentage\": 0,
\"total-amount\": 134.4,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/78\",
\"path\": \"app.stelorder.com/app/workEstimates/71\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/47\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 71,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 83,
\"document-state-id\": 78,
\"serial-number-id\": 47,
\"email-read-count\": 0,
\"payment-option-id\": 11,
\"account-id\": 83,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 22.4,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": \"app.stelorder.com/app/bankAccounts/20\",
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"work-address-id\": null,
\"rate-id\": null,
\"validity-date\": null,
\"creation-date\": \"2016-11-28T18:28:53+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"work-address-path\": null,
\"invoice-to-account-id\": null,
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"title\": \"Oven repairs\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 112,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 22.4
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/83\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/71\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 35,
\"deleted\": false,
\"item-id\": 71,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"NC Thermostat\",
\"item-deleted\": false,
\"item-description\": \"It opens with an increase in temperature, from 0 to 60º C\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 275,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 35
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/69\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 27,
\"deleted\": false,
\"item-id\": 69,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Oven Resistance 2000 W 220 V\",
\"item-deleted\": false,
\"item-description\": \"Ideal for any type of oven.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 273,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 27
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/76\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 50,
\"deleted\": false,
\"item-id\": 76,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Labor Costs (30 min.)\",
\"item-deleted\": false,
\"item-description\": \"Your labor costs every 30 minutes, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 274,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 25
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 112,
\"signature-name\": null,
\"parent-incident-path\": null,
\"invoice-to-account-path\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"WE00001\",
\"currency-code\": \"USD\"
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["WorkEstimates"],"summary":"Resource to create a new work estimate","operationId":"doPost_35","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/WorkEstimatePost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/workEstimates/{ID}":{"get":{"tags":["WorkEstimates"],"summary":"Resource to get a work estimate by ID.","operationId":"doGetById_49","parameters":[{"name":"ID","in":"path","description":"ID of work estimate","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a work estimate (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"parent-incident-id\": null,
\"bank-account-id\": 20,
\"account-path\": \"app.stelorder.com/app/clients/83\",
\"discount-percentage\": 0,
\"total-amount\": 134.4,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/78\",
\"path\": \"app.stelorder.com/app/workEstimates/71\",
\"private-comments\": \"You can insert private comments here\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/47\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"addendum\": null,
\"id\": 71,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 83,
\"document-state-id\": 78,
\"serial-number-id\": 47,
\"email-read-count\": 0,
\"payment-option-id\": 11,
\"account-id\": 83,
\"settled\": false,
\"signed\": false,
\"tax-total-amount\": 22.4,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": \"app.stelorder.com/app/bankAccounts/20\",
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"work-address-id\": null,
\"rate-id\": null,
\"validity-date\": null,
\"creation-date\": \"2016-11-28T18:28:53+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"work-address-path\": null,
\"invoice-to-account-id\": null,
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"title\": \"Oven repairs\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 112,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 22.4
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/83\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/71\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 35,
\"deleted\": false,
\"item-id\": 71,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"NC Thermostat\",
\"item-deleted\": false,
\"item-description\": \"It opens with an increase in temperature, from 0 to 60º C\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 275,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 35
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/products/69\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 1,
\"discount-percentage\": 0,
\"total-amount\": 27,
\"deleted\": false,
\"item-id\": 69,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Oven Resistance 2000 W 220 V\",
\"item-deleted\": false,
\"item-description\": \"Ideal for any type of oven.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 273,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 27
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/76\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 50,
\"deleted\": false,
\"item-id\": 76,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00003\",
\"item-name\": \"Labor Costs (30 min.)\",
\"item-deleted\": false,
\"item-description\": \"Your labor costs every 30 minutes, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 274,
\"income-tax-enabled\": false,
\"order\": 2,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 25
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 112,
\"signature-name\": null,
\"parent-incident-path\": null,
\"invoice-to-account-path\": null,
\"deleted\": false,
\"agent-id\": 1,
\"signature-tax-identification-number\": null,
\"full-reference\": \"WE00001\",
\"currency-code\": \"USD\"
\"id\": 17
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["WorkEstimates"],"summary":"Resource to update an existing work estimate","operationId":"doPut_37","parameters":[{"name":"ID","in":"path","description":"ID of work estimate","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/WorkEstimatePut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["WorkEstimates"],"summary":"Resource to delete an existing work estimate","operationId":"doDelete_32","parameters":[{"name":"ID","in":"path","description":"ID of work estimate","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/workOrders":{"get":{"tags":["WorkOrders"],"summary":"Resource to get a work order or a list of work orders. The list is limited to 100 items per request by default but can be increased to 500 using limit clause.","operationId":"doGet_55","parameters":[{"name":"full-reference","in":"query","description":"Filter clause (examples -> 'full-reference=foo', 'full-reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Filter clause (examples -> 'reference=foo', 'reference=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"title","in":"query","description":"Filter clause (examples -> 'title=foo', 'title=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"date","in":"query","description":"Filter clause (examples -> 'date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"start-date","in":"query","description":"Filter all work orders from date (examples -> 'start-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"end-date","in":"query","description":"Filter all work orders until date (examples -> 'end-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"external-id","in":"query","description":"Filter clause (examples -> 'external-id=foo', 'external-id=in:foo,bar' (like OR clause))
","schema":{"type":"string"}},{"name":"serial-number-id","in":"query","description":"Filter clause (examples -> 'serial-number-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"account-id","in":"query","description":"Filter clause (examples -> 'account-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"creator-id","in":"query","description":"Filter clause (examples -> 'creator-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"agent-id","in":"query","description":"Filter clause (examples -> 'agent-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"assignee-id","in":"query","description":"Filter clause (examples -> 'assignee-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"document-state-id","in":"query","description":"Filter clause (examples -> 'document-state-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"parent-document-id","in":"query","description":"Filter clause (examples -> 'parent-document-id=1')
","schema":{"type":"integer","format":"int64"}},{"name":"utc-last-modification-date","in":"query","description":"Filter all modified work orders from the date in UTC (examples -> 'utc-last-modification-date=2025-01-15T00:00:00+0000')
","schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"Sort clause (examples -> 'sort=reference', 'sort=reference:asc,reference:asc,date:desc')
Sorting fields allowed: full-reference, reference, title, date, creation-date, external-id, serial-number-id, account-id, creator-id, agent-id, assignee-id, document-state-id, utc-last-modification-date ","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit clause (example -> 'limit=30')","schema":{"type":"integer","format":"int64"}},{"name":"start","in":"query","description":"Start clause (example -> 'start=30&limit=30' shows the second page of 30 items)","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a work order list (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"assignee-path\": null,
\"parent-incident-id\": 7,
\"bank-account-id\": null,
\"assignee-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/87\",
\"discount-percentage\": 0,
\"total-amount\": 178.8,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/107\",
\"path\": \"app.stelorder.com/app/workOrders/68\",
\"private-comments\": \"Configure internet connection and network\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/58\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": null,
\"addendum\": null,
\"id\": 68,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 77,
\"document-state-id\": 107,
\"serial-number-id\": 58,
\"email-read-count\": 0,
\"payment-option-id\": 11,
\"account-id\": 87,
\"settled\": false,
\"parent-document-id\": null,
\"signed\": false,
\"tax-total-amount\": 29.8,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"work-address-id\": null,
\"rate-id\": null,
\"creation-date\": \"2016-11-28T18:13:16+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"work-address-path\": null,
\"invoice-to-account-id\": null,
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"start-date\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 149,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 29.8
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/77\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"due-date\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/76\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 50,
\"deleted\": false,
\"item-id\": 76,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Labor Costs (30 min.)\",
\"item-deleted\": false,
\"item-description\": \"Your labor costs every 30 minutes, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 267,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 25
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/75\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 3,
\"discount-percentage\": 0,
\"total-amount\": 99,
\"deleted\": false,
\"item-id\": 75,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Configuration Service Costs\",
\"item-deleted\": false,
\"item-description\": \"Your configuration services price, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 268,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 33
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 149,
\"delivery-option-path\": null,
\"signature-name\": null,
\"parent-incident-path\": \"app.stelorder.com/app/incidents/7\",
\"invoice-to-account-path\": null,
\"end-date\": null,
\"deleted\": false,
\"agent-id\": 1,
\"assigned-date\": null,
\"signature-tax-identification-number\": null,
\"full-reference\": \"WO00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"post":{"tags":["WorkOrders"],"summary":"Resource to create a new work order","operationId":"doPost_36","requestBody":{"description":"Minimum body:
{
\"account-id\": 50,
\"lines\": [
{
\"line-type\": \"ITEM\",
\"item-id\": 34
}
]
} ","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/WorkOrderPost"}}},"required":true},"responses":{"200":{"description":"Returns created object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}},"/app/workOrders/{ID}":{"get":{"tags":["WorkOrders"],"summary":"Resource to get a work order by ID.","operationId":"doGetById_50","parameters":[{"name":"ID","in":"path","description":"ID of work order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns a work order (if there are any result)
[{
\"utc-last-modification-date\": \"2019-06-21T10:44:19+0000\",
\"date\": \"2016-11-28T00:00:00+0000\",
\"email-last-read-date\": null,
\"email-sent-to\": null,
\"assignee-path\": null,
\"parent-incident-id\": 7,
\"bank-account-id\": null,
\"assignee-id\": null,
\"account-path\": \"app.stelorder.com/app/clients/87\",
\"discount-percentage\": 0,
\"total-amount\": 178.8,
\"pdf-path\": \"\",
\"reference\": \"00001\",
\"document-state-path\": \"app.stelorder.com/app/documentStates/107\",
\"path\": \"app.stelorder.com/app/workOrders/68\",
\"private-comments\": \"Configure internet connection and network\",
\"serial-number-path\": \"app.stelorder.com/app/serialNumbers/58\",
\"assets\": [],
\"email-first-read-date\": null,
\"external-id\": null,
\"parent-document-path\": null,
\"addendum\": null,
\"id\": 68,
\"income-tax-enabled\": false,
\"invoicing-address-id\": 77,
\"document-state-id\": 107,
\"serial-number-id\": 58,
\"email-read-count\": 0,
\"payment-option-id\": 11,
\"account-id\": 87,
\"settled\": false,
\"parent-document-id\": null,
\"signed\": false,
\"tax-total-amount\": 29.8,
\"agent-path\": \"app.stelorder.com/app/employees/1\",
\"bank-account-path\": null,
\"secondary-tax-enabled\": false,
\"creator-path\": \"app.stelorder.com/app/employees/1\",
\"work-address-id\": null,
\"rate-id\": null,
\"creation-date\": \"2016-11-28T18:13:16+0000\",
\"payment-option-path\": \"app.stelorder.com/app/paymentOptions/11\",
\"work-address-path\": null,
\"invoice-to-account-id\": null,
\"currency-rate\": 1,
\"discount-total-amount\": 0,
\"delivery-option-id\": null,
\"start-date\": null,
\"title\": \"You can insert a title here\",
\"tax-breakdown\": [
{
\"subtotal-amount\": 149,
\"tax-percentage\": 20,
\"tax-name\": \"SalesTax\",
\"type\": \"PRIMARY\",
\"total-amount\": 29.8
}
],
\"invoicing-address-path\": \"app.stelorder.com/app/addresses/77\",
\"email-sent-date\": null,
\"primary-tax-enabled\": true,
\"rate-path\": null,
\"due-date\": null,
\"lines\": [
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/76\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 2,
\"discount-percentage\": 0,
\"total-amount\": 50,
\"deleted\": false,
\"item-id\": 76,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00001\",
\"item-name\": \"Labor Costs (30 min.)\",
\"item-deleted\": false,
\"item-description\": \"Your labor costs every 30 minutes, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 267,
\"income-tax-enabled\": false,
\"order\": 0,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 25
},
{
\"primary-tax-percentage\": 20,
\"item-path\": \"app.stelorder.com/app/services/75\",
\"line-type\": \"ITEM\",
\"parent-document-id\": null,
\"income-tax-percentage\": 0,
\"units\": 3,
\"discount-percentage\": 0,
\"total-amount\": 99,
\"deleted\": false,
\"item-id\": 75,
\"secondary-tax-percentage\": 0,
\"primary-tax-path\": \"app.stelorder.com/app/taxLines/16\",
\"item-reference\": \"PRO00002\",
\"item-name\": \"Configuration Service Costs\",
\"item-deleted\": false,
\"item-description\": \"Your configuration services price, so you can include this in your invoices.\",
\"parent-document-path\": null,
\"primary-tax-id\": 16,
\"id\": 268,
\"income-tax-enabled\": false,
\"order\": 1,
\"warehouse-id\": -2,
\"warehouse-path\": \"app.stelorder.com/app/warehouses/-2\",
\"item-purchase-price\": 2,
\"item-base-price\": 33
}
],
\"creator-id\": 1,
\"comments\": \"You can insert comments here\",
\"subtotal-amount\": 149,
\"delivery-option-path\": null,
\"signature-name\": null,
\"parent-incident-path\": \"app.stelorder.com/app/incidents/7\",
\"invoice-to-account-path\": null,
\"end-date\": null,
\"deleted\": false,
\"agent-id\": 1,
\"assigned-date\": null,
\"signature-tax-identification-number\": null,
\"full-reference\": \"WO00001\",
\"currency-code\": \"USD\"
}]","content":{"application/json; charset=utf-8":{}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"put":{"tags":["WorkOrders"],"summary":"Resource to update an existing work order","operationId":"doPut_38","parameters":[{"name":"ID","in":"path","description":"ID of work order","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/WorkOrderPut"}}},"required":true},"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]},"delete":{"tags":["WorkOrders"],"summary":"Resource to delete an existing work order","operationId":"doDelete_33","parameters":[{"name":"ID","in":"path","description":"ID of work order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returns updated object data"},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"}},"security":[{"APIKEY":[]}]}}},"components":{"schemas":{"AccountCategoryPost":{"title":"AccountCategory (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Non-empty name for the account category. With double quotes."},"description":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true},"rate-id":{"type":"integer","description":"Existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"AccountCategoryPut":{"title":"AccountCategory (PUT)","type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"description":{"maxLength":512,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true},"rate-id":{"type":"integer","description":"Missing attribute (keep), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"AddressPost":{"title":"Address (POST)","required":["account-id","address-data"],"type":"object","properties":{"address-data":{"maxLength":256,"type":"string","description":"Non-empty address-data for the address. With double quotes."},"postal-code":{"maxLength":10,"type":"string","description":"With double quotes.","nullable":true},"province":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"city-town":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"country-code":{"maxLength":3,"type":"string","description":"Missing attribute (default we take this value from my business settings) or ISO 3166-1 Alpha 2 code. Example ES, GB, US, FR... https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 (for tax purposes: ES1 for Canary Island, ES2 for Ceuta and Melilla). With double quotes."},"latitude":{"maximum":90,"minimum":-90,"type":"number","description":"Missing attribute (default empty), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"longitude":{"maximum":180,"minimum":-180,"type":"number","description":"Missing attribute (default empty), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"extra-data":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"account-id":{"type":"integer","description":"Existing account id. Without quotes.","format":"int64"},"address-type":{"type":"string","description":"Missing attribute (default) or address type (DEFAULT cannot be used in Address POST). With double quotes.","enum":["OTHER","DEFAULT","INVOICING","DELIVERY"],"default":"OTHER"}}},"AddressPut":{"title":"Address (PUT)","type":"object","properties":{"address-data":{"maxLength":256,"type":"string","description":"Missing attribute (keep) or address data. With double quotes."},"postal-code":{"maxLength":10,"type":"string","description":"Missing attribute (keep), postal code or null/\"\" (empty). With double quotes.","nullable":true},"province":{"maxLength":64,"type":"string","description":"Missing attribute (keep), province or null/\"\" (empty). With double quotes.","nullable":true},"city-town":{"maxLength":64,"type":"string","description":"Missing attribute (keep), city/town or null/\"\" (empty). With double quotes.","nullable":true},"country-code":{"maxLength":3,"type":"string","description":"Missing attribute (keep) or ISO 3166-1 Alpha 2 code. Example ES, GB, US, FR... https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 (for tax purposes: ES1 for Canary Island, ES2 for Ceuta and Melilla). With double quotes."},"latitude":{"maximum":90,"minimum":-90,"type":"number","description":"Missing attribute (keep), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"longitude":{"maximum":180,"minimum":-180,"type":"number","description":"Missing attribute (keep), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"extra-data":{"maxLength":128,"type":"string","description":"Missing attribute (keep), extra data or null/\"\" (empty). With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"Missing attribute (keep), name or null/\"\" (empty). With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). Without quotes.","nullable":true},"address-type":{"type":"string","description":"Missing attribute (keep) or address type (DEFAULT cannot be used in Address PUT). With double quotes.","enum":["OTHER","DEFAULT","INVOICING","DELIVERY"]}}},"AssetImagePost":{"title":"AssetImage (POST)","required":["asset-id","image-url"],"type":"object","properties":{"image-url":{"type":"string","description":"Non-empty url image. With double quotes."},"order":{"minimum":0,"type":"integer","description":"Missing attribute (default last position of the asset images) or order of the image into the asset images. Without quotes.","format":"int32"},"asset-id":{"type":"integer","description":"Existing asset id. Without quotes.","format":"int64"}}},"AssetPost":{"title":"Asset (POST)","required":["name"],"type":"object","properties":{"reference":{"type":"string","description":"If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing attribute or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes. Max-length = 32","nullable":true},"name":{"maxLength":255,"type":"string","description":"Non-empty name for the asset. With double quotes."},"identifier":{"maxLength":255,"type":"string","description":"With double quotes.","nullable":true},"serial-number":{"maxLength":255,"type":"string","description":"With double quotes.","nullable":true},"brand":{"maxLength":255,"type":"string","description":"With double quotes.","nullable":true},"model":{"maxLength":255,"type":"string","description":"With double quotes.","nullable":true},"subject-to-maintenance":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"warranty-start-date":{"type":"string","description":"Warranty start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empy). With double quotes.","format":"date-time","nullable":true},"warranty-end-date":{"type":"string","description":"Warranty end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"description":{"maxLength":1024,"type":"string","description":"With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object. If you want to use MANUAL reference then use -2.","format":"int64"},"address-id":{"type":"integer","description":"Existing address id (default we take the main address from account when setting account) or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"AssetPut":{"title":"Asset (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one, you cant leave it null or empty when MANUAL serial number is chosen). If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing attribute or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"name":{"maxLength":255,"type":"string","description":"Missing attribute (keep) or name. With double quotes."},"identifier":{"maxLength":255,"type":"string","description":"Missing attribute (keep), identifier or null/\"\" (empty). With double quotes. Max-length = 255","nullable":true},"serial-number":{"maxLength":255,"type":"string","description":"Missing attribute (keep), serial number or null/\"\" (empty). With double quotes. Max-length = 255","nullable":true},"brand":{"maxLength":255,"type":"string","description":"Missing attribute (keep), brand or null/\"\" (empty). With double quotes. Max-length = 255","nullable":true},"model":{"maxLength":255,"type":"string","description":"Missing attribute (keep), model or null/\"\" (empty). With double quotes. Max-length = 255","nullable":true},"subject-to-maintenance":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"warranty-start-date":{"type":"string","description":"Missing attribute (keep), warranty start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"warranty-end-date":{"type":"string","description":"Missing attribute (keep), warranty end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"description":{"maxLength":1024,"type":"string","description":"Missing attribute (keep), description or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"Missing attribute (keep), private comment or null/\"\" (empty). With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep), existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes. If you want to use MANUAL reference then use -2.","format":"int64"},"address-id":{"type":"integer","description":"Missing attribute (keep or the main address from account when setting a different account), existing address id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"BankAccountPost":{"title":"BankAccount (POST)","required":["account"],"type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Name for the bank account. With double quotes.","nullable":true},"description":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true},"default":{"type":"boolean","description":"True or false. Without quotes.","default":false},"account":{"maxLength":256,"type":"string","description":"Non-empty international bank account number (IBAN or other format). With double quotes."},"bic-swift":{"maxLength":30,"type":"string","description":"BIC or SWIFT code. With double quotes.","nullable":true}}},"BankAccountPut":{"title":"BankAccount (PUT)","type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or non-empty name for the bank account. With double quotes.","nullable":true},"description":{"maxLength":512,"type":"string","description":"Missing attribute (keep), description or null/\"\" (empty). With double quotes.","nullable":true},"default":{"type":"boolean","description":"Missing attribute (keep), true or false. Without quotes."},"bic-swift":{"maxLength":30,"type":"string","description":"Missing attribute (keep), BIC or SWIFT code or null/\"\" (empty). With double quotes.","nullable":true}}},"ClientPost":{"title":"Client (POST)","required":["legal-name"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"legal-name":{"maxLength":128,"type":"string","description":"Non-empty legal name for the client. With double quotes."},"name":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"tax-identification-number":{"maxLength":30,"type":"string","description":"With double quotes.","nullable":true},"phone":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"phone2":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Valid email, we will check the format. With double quotes.","nullable":true},"website":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true},"comments":{"maxLength":4096,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from CONSUMPTION sales tax settings), true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from CONSUMPTION sales tax settings), true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the next client account from accounting settings) or valid countable account. With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"agent-id":{"type":"integer","description":"Existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"rate-id":{"type":"integer","description":"Existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-category-id":{"type":"integer","description":"Existing account category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"main-address":{"$ref":"#/components/schemas/MainAddressPost"},"payment-terms-id":{"type":"integer","description":"Existing payment term id or null (Inmediate Payment). Without quotes.","format":"int64","nullable":true},"payment-day":{"maximum":31,"minimum":1,"type":"integer","description":"Day number 1 to 31. Without quotes. If a day is passed you must choose payment-adjustment too (PREVIOUS, LATER, CLOSEST).","format":"int32"},"invoice-to-account-id":{"type":"integer","description":"Existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing we use the default serial number of this kind of object. If you want to use MANUAL reference then use -2.","format":"int64"},"payment-adjustment":{"type":"string","description":"One of these values if you define a payment-day (PREVIOUS, LATER, CLOSEST). With double quotes.","enum":["UNDEFINED","PREVIOUS","LATER","CLOSEST"],"default":"UNDEFINED"},"currency-code":{"type":"string","description":"Missing attribute (default we take this value from my business settings) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from payment options settings), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"MainAddressPost":{"title":"MainAddress (POST)","type":"object","properties":{"address-data":{"maxLength":256,"type":"string","description":"With double quotes.","nullable":true},"postal-code":{"maxLength":10,"type":"string","description":"With double quotes.","nullable":true},"province":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"city-town":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"country-code":{"maxLength":3,"type":"string","description":"Missing attribute (default we take this value from my business settings) or ISO 3166-1 Alpha 2 code. Example ES, GB, US, FR... https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 (for tax purposes: ES1 for Canary Island, ES2 for Ceuta and Melilla). With double quotes."},"latitude":{"maximum":90,"minimum":-90,"type":"number","description":"Missing attribute (default empty), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"longitude":{"maximum":180,"minimum":-180,"type":"number","description":"Missing attribute (default empty), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true}},"description":"You must specify at least the country when include a main address."},"ClientPut":{"title":"Client (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one, you cant leave it null or empty when MANUAL serial number is chosen). If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"legal-name":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"name":{"maxLength":128,"type":"string","description":"Missing attribute (keep), name or null/\"\" (empty). With double quotes.","nullable":true},"tax-identification-number":{"maxLength":30,"type":"string","description":"Missing attribute (keep), tax identification number or null/\"\" (empty). With double quotes.","nullable":true},"phone":{"maxLength":32,"type":"string","description":"Missing attribute (keep), phone or null/\"\" (empty). With double quotes.","nullable":true},"phone2":{"maxLength":32,"type":"string","description":"Missing attribute (keep), phone or null/\"\" (empty). With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"Missing attribute (keep), fax or null/\"\" (empty). With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Missing attribute (keep), valid email or null/\"\" (empty). With double quotes.","nullable":true},"website":{"maxLength":512,"type":"string","description":"Missing attribute (keep), website or null/\"\" (empty). With double quotes.","nullable":true},"comments":{"maxLength":4096,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid countable account or null/\"\" (empty). With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"agent-id":{"type":"integer","description":"Missing attribute (keep), existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"rate-id":{"type":"integer","description":"Missing attribute (keep), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-category-id":{"type":"integer","description":"Missing attribute (keep), existing account category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"main-address":{"$ref":"#/components/schemas/MainAddressPut"},"payment-terms-id":{"type":"integer","description":"Missing attribute (keep), existing payment terms id or null (Inmediate Payment). Without quotes.","format":"int64","nullable":true},"payment-day":{"maximum":31,"minimum":1,"type":"integer","description":"Missing attribute (keep), null (unassigned) or day 1 to 31. Without quotes. If a day is passed you must choose payment-adjustment too (PREVIOUS, LATER, CLOSEST)","format":"int32"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (keep), existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes. If you want to use MANUAL reference then use -2.","format":"int64"},"payment-adjustment":{"type":"string","description":"Missing attribute (keep) or one of these values if you define a payment-day (PREVIOUS, LATER, CLOSEST). With double quotes.","enum":["UNDEFINED","PREVIOUS","LATER","CLOSEST"]},"currency-code":{"type":"string","description":"Missing attribute (keep) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"MainAddressPut":{"title":"MainAddress (PUT)","type":"object","properties":{"address-data":{"maxLength":256,"type":"string","description":"Missing attribute (keep), address data or null/\"\" (empty). With double quotes.","nullable":true},"postal-code":{"maxLength":10,"type":"string","description":"Missing attribute (keep), postal code or null/\"\" (empty). With double quotes.","nullable":true},"province":{"maxLength":64,"type":"string","description":"Missing attribute (keep), province or null/\"\" (empty). With double quotes.","nullable":true},"city-town":{"maxLength":64,"type":"string","description":"Missing attribute (keep), city/town or null/\"\" (empty). With double quotes.","nullable":true},"country-code":{"maxLength":3,"type":"string","description":"Missing attribute (keep) or ISO 3166-1 Alpha 2 code. Example ES, GB, US, FR... https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 (for tax purposes: ES1 for Canary Island, ES2 for Ceuta and Melilla). With double quotes."},"latitude":{"maximum":90,"minimum":-90,"type":"number","description":"Missing attribute (keep), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"longitude":{"maximum":180,"minimum":-180,"type":"number","description":"Missing attribute (keep), fill both (longitude and latitude (decimal format like -63.572375)) or null (empty). Without quotes.","format":"double","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). Without quotes.","nullable":true}}},"ContactPost":{"title":"Contact (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":64,"type":"string","description":"Non-empty name for the contact. With double quotes."},"phone":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Valid email, we will check the format. With double quotes.","nullable":true},"comments":{"maxLength":1024,"type":"string","description":"With double quotes.","nullable":true},"position":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"account-id":{"type":"integer","description":"Existing account id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"ContactPut":{"title":"Contact (PUT)","type":"object","properties":{"name":{"maxLength":64,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"phone":{"maxLength":32,"type":"string","description":"Missing attribute (keep), phone or null/\"\" (empty). With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"Missing attribute (keep), fax or null/\"\" (empty). With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Missing attribute (keep), email or null/\"\" (empty). With double quotes.","nullable":true},"comments":{"maxLength":1024,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true},"position":{"maxLength":128,"type":"string","description":"Missing attribute (keep), job title or null/\"\" (empty). With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep), existing account id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"DeliveryOptionPost":{"title":"DeliveryOption (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Non-empty name for the delivery option. With double quotes."},"description":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true}}},"DeliveryOptionPut":{"title":"DeliveryOption (PUT)","type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"description":{"maxLength":512,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true}}},"EntityAttachmentsPost":{"title":"EntityAttachments (POST)","required":["entity-id","entity-type","file-url"],"type":"object","properties":{"file-url":{"type":"string","description":"URL pointing to the file to be downloaded and attached. With double quotes.","example":"https://storage.googleapis.com/storagestelordersite/documento.pdf"},"entity-id":{"type":"integer","description":"Entity ID to which the attachment will be linked. Without quotes.","format":"int64","example":12345},"entity-type":{"type":"string","description":"Entity type. Must be one of the allowed values. With double quotes.","example":"WORKORDER","enum":["PRODUCT","SERVICE","EXPENSEANDINVESTMENT","ASSET","CLIENT","POTENTIALCLIENT","SUPPLIER","SALESESTIMATE","SALESORDER","SALESDELIVERYNOTE","INCIDENT","WORKESTIMATE","WORKORDER","WORKDELIVERYNOTE","ORDINARYINVOICE","REFUNDINVOICE","PURCHASEORDER","PURCHASEDELIVERYNOTE","PURCHASEINVOICE","EXPENSE","EVENT"]}},"description":"Model for creating an attachment linked to any entity using a URL"},"EventTypePost":{"title":"EventType (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Non-empty name for the event type. With double quotes."},"color":{"maxLength":7,"type":"string","description":"Hex color code or name. With double quotes.","example":"#61B990","default":"#61B990"}}},"EventTypePut":{"title":"EventType (PUT)","type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or non-empty name for the event type. With double quotes."},"color":{"maxLength":7,"type":"string","description":"Missing attribute (keep), color or null/\"\" (empty). With double quotes."}}},"EventPost":{"title":"Event (POST)","required":["end-date","start-date"],"type":"object","properties":{"subject":{"maxLength":128,"type":"string","description":"With double quotes."},"description":{"maxLength":5000,"type":"string","description":"With double quotes."},"location":{"maxLength":128,"type":"string","description":"With double quotes."},"start-date":{"type":"string","description":"Non empty event start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"end-date":{"type":"string","description":"Non empty event end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"all-day":{"type":"boolean","description":"Missing attribute (default), true or false . Without quotes.","default":false},"calendar-id":{"type":"integer","description":"Existing calendar id or missing (default we take the default calendar from the api employee). Without quotes.","format":"int64"},"account-id":{"type":"integer","description":"Existing client/potential client/supplier id or null (unassigned). Without quotes.","format":"int64","nullable":true},"event-type-id":{"type":"integer","description":"Existing event type id or null (unassigned). Without quotes.","format":"int64","nullable":true},"event-state":{"type":"string","description":"Missing attribute (default) or PENDING, REFUSED, COMPLETED. With double quotes.","enum":["PENDING","COMPLETED","REFUSED"],"default":"PENDING"},"document-id":{"type":"integer","description":"Existing document id or null (unassigned). You can only set this value if u do not use the incident-id value. Without quotes.","format":"int64","nullable":true},"incident-id":{"type":"integer","description":"Existing incident id or null (unassigned). You can only set this value if u do not use the document-id value. Without quotes.","format":"int64","nullable":true}}},"EventPut":{"title":"Event (PUT)","type":"object","properties":{"subject":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or subject with double quotes."},"description":{"maxLength":5000,"type":"string","description":"Missing attribute (keep) or description with double quotes."},"location":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or location with double quotes."},"start-date":{"type":"string","description":"Missing attribute (keep) or event start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"end-date":{"type":"string","description":"Missing attribute (keep) or event end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"all-day":{"type":"boolean","description":"Missing attribute (keep), true or false . Without quotes.","default":false},"account-id":{"type":"integer","description":"Missing attribute (keep), existing client/potential client/supplier id or null (unassigned). Without quotes.","format":"int64","nullable":true},"event-type-id":{"type":"integer","description":"Missing attribute (keep), existing event type id or null (unassigned). Without quotes.","format":"int64","nullable":true},"event-state":{"type":"string","description":"Missing attribute (keep) or PENDING, REFUSED, COMPLETED. With double quotes.","enum":["PENDING","COMPLETED","REFUSED"],"default":"PENDING"}}},"ExpensePost":{"title":"Expense (POST)","required":["expense-category-id"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"date":{"type":"string","description":"Missing attribute (default now) or expense date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"description":{"maxLength":1024,"type":"string","description":"Description for the expense. With double quotes.","nullable":true},"payment-date":{"type":"string","description":"Missing attribute (default now) or payment date in format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value can only be set if the status of the receipt is paid. With double quotes.","format":"date-time"},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the expense countable account from accounting settings) or valid countable account. With double quotes.","nullable":true},"employee-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing we use the default serial number of this kind of object.","format":"int64"},"expense-category-id":{"type":"integer","description":"Existing expense category id. Without quotes.","format":"int64"},"supplier-id":{"type":"integer","description":"Existing supplier id or null (unassigned). Without quotes.","format":"int64","nullable":true},"amount":{"minimum":0,"type":"number","description":"Expense total amount. Without quotes.","format":"double","default":0},"paid-employee-id":{"type":"integer","description":"Existing employee id who paid or null. This value can only be set if the status of the receipt is paid. Without quotes.","format":"int64"},"expense-state-id":{"type":"integer","description":"Missing attribute (default we take the expense state with lower order) or existing expense state id. Without quotes.","format":"int64"},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from supplier properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true}}},"ExpensePut":{"title":"Expense (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"date":{"type":"string","description":"Missing attribute (keep) or expense date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"description":{"maxLength":1024,"type":"string","description":"Missing attribute (keep), description or null/\"\" (empty). With double quotes.","nullable":true},"payment-date":{"type":"string","description":"Missing attribute (keep) or expense payment date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value can only be set if the status of the expense is paid. With double quotes.","format":"date-time"},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid countable account or null/\"\" (empty). With double quotes.","nullable":true},"employee-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"expense-category-id":{"type":"integer","description":"Missing attribute (keep) or existing expense category id. Without quotes.","format":"int64"},"supplier-id":{"type":"integer","description":"Missing attribute (keep), existing supplier id or null (unassigned). Without quotes.","format":"int64","nullable":true},"amount":{"minimum":0,"type":"number","description":"Missing attribute (keep) or expense total amount. Without quotes.","format":"double"},"paid-employee-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. This value can only be set if the status of the receipt is paid. Without quotes.","format":"int64"},"expense-state-id":{"type":"integer","description":"Missing attribute (keep) or existing expense status id. Without quotes.","format":"int64"},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from supplier properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true}}},"ExpenseAndInvestmentPost":{"title":"Expense and investment (POST)","required":["name"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"Non-empty name for the expense and investmentPost. With double quotes."},"description":{"maxLength":2048,"type":"string","description":"With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"With double quotes.","nullable":true},"purchase-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the purchase countable account from accounting settings) or valid purchase countable account. With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-id":{"type":"integer","description":"Missing attribute (default we take this value from CONSUMPTION tax settings) or existing tax line id of type CONSUMPTION (takes priority over primary tax percentage). Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from primary-tax-id). Without quotes.","format":"double"},"purchase-price":{"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"expense-category-id":{"type":"integer","description":"Existing expense category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"type":{"type":"string","description":"Missing attribute (default) or EXPENSE/INVESTMENT, when you choose EXPENSE you can only set expense category of type EXPENSE. If INVESTMENT you can only set expense category of type INVESTMENT. With double quotes.","enum":["EXPENSE","INVESTMENT"],"default":"EXPENSE"}}},"ExpenseAndInvestmentPut":{"title":"Expense and investment (PUT)","required":["type"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or name. With double quotes."},"description":{"maxLength":2048,"type":"string","description":"Missing attribute (keep), description or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"Missing attribute (keep), private comment or null/\"\" (empty). With double quotes.","nullable":true},"purchase-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid purchase countable account or null/\"\" (empty). With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-id":{"type":"integer","description":"Missing attribute (keep) or existing tax line id of type CONSUMPTION (takes priority over primary tax percentage). Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"purchase-price":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"expense-category-id":{"type":"integer","description":"Missing attribute (keep), existing expense category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"type":{"type":"string","description":"Missing attribute (keep) or EXPENSE/INVESTMENT, when you choose EXPENSE you can only set expense category of type EXPENSE. If INVESTMENT you can only set expense category of type INVESTMENT. With double quotes.","enum":["EXPENSE","INVESTMENT"]}}},"IncidentTypePost":{"title":"IncidentType (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":250,"type":"string","description":"Non-empty name for the incident type. With double quotes."},"description":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true},"color":{"maxLength":7,"type":"string","description":"Hex color code or name. With double quotes.","example":"#FFFFFF","default":"#FFFFFF"}}},"IncidentTypePut":{"title":"IncidentType (PUT)","type":"object","properties":{"name":{"maxLength":250,"type":"string","description":"Missing attribute (keep) or non-empty name for the incident type. With double quotes."},"description":{"maxLength":512,"type":"string","description":"Missing attribute (keep), description or null/\"\" (empty). With double quotes.","nullable":true},"color":{"maxLength":7,"type":"string","description":"Missing attribute (keep), color or null/\"\" (empty). With double quotes."}}},"IncidentAssetPost":{"title":"IncidentAsset (POST)","required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"Existing asset id. Without quotes.","format":"int64"}},"description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true},"IncidentPost":{"title":"Incident (POST)","required":["description"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"description":{"maxLength":2048,"type":"string","description":"Non-empty description for the incident. With double quotes."},"phone":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"length":{"minimum":0,"type":"integer","description":"Missing attribute (default zero) or length in minutes. Without quotes.","format":"int64"},"resolution":{"maxLength":2048,"type":"string","description":"With double quotes.","nullable":true},"date":{"type":"string","description":"Missing attribute (default now) or incident date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"creation-notification":{"type":"boolean","description":"Missing attribute (default we take this value from CONNECT incidents creation notification settings), true or false. Without quotes."},"closed-notification":{"type":"boolean","description":"Missing attribute (default we take this value from CONNECT incidents closed notification settings), true or false. Without quotes."},"account-id":{"type":"integer","description":"Existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"invoice-to-account-id":{"type":"integer","description":"Existing client/potential client id (default we take the invoice to account from account when setting account) or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing we use the default serial number of this kind of object.","format":"int64"},"assets":{"type":"array","description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true,"items":{"$ref":"#/components/schemas/IncidentAssetPost"}},"incident-type-id":{"type":"integer","description":"Existing incident type id or null (unassigned). Without quotes.","format":"int64","nullable":true},"incident-state-id":{"type":"integer","description":"Missing attribute (default we take the incident state with lower order) or existing incident state id. Without quotes.","format":"int64"},"assignee-id":{"type":"integer","description":"Existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"address-id":{"type":"integer","description":"Existing address id (default we take the delivery address or main address from account when setting account) or null (unassigned). Without quotes.","format":"int64","nullable":true},"priority":{"type":"string","description":"Missing attribute (default) or VERYLOW, LOW, NORMAL, HIGH, VERYHIGH. With double quotes.","enum":["VERYLOW","LOW","NORMAL","HIGH","VERYHIGH"],"default":"NORMAL"}}},"IncidentAssetPut":{"title":"IncidentAsset (PUT)","required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"Existing asset id. Without quotes.","format":"int64"}},"description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true},"IncidentPut":{"title":"Incident (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"description":{"maxLength":2048,"type":"string","description":"Missing attribute (keep) or description. With double quotes."},"phone":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or phone. With double quotes."},"resolution":{"maxLength":2048,"type":"string","description":"Missing attribute (keep) or resolution. With double quotes."},"date":{"type":"string","description":"Missing attribute (keep) or incident date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"creation-notification":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"closed-notification":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"account-id":{"type":"integer","description":"Missing attribute (keep), existing client/potential cliente id or null (unassigned). Without quotes.","format":"int64","nullable":true},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (keep or the invoice to account from account when setting a different account), existing client/potential cliente id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"assets":{"type":"array","description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true,"items":{"$ref":"#/components/schemas/IncidentAssetPut"}},"incident-type-id":{"type":"integer","description":"Missing attribute (keep), existing incident type id or null (unassigned). Without quotes.","format":"int64","nullable":true},"incident-state-id":{"type":"integer","description":"Missing attribute (keep) or existing incident state id. Without quotes.","format":"int64"},"assignee-id":{"type":"integer","description":"Missing attribute (keep), existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"address-id":{"type":"integer","description":"Missing attribute (keep or delivery address or main address from account when setting a different account), existing address id or null (unassigned). Without quotes.","format":"int64","nullable":true},"length":{"minimum":0,"type":"number","description":"Missing attribute (keep) or length. Without quotes.","format":"double"},"priority":{"type":"string","description":"Missing attribute (keep) or VERYLOW, LOW, NORMAL, HIGH, VERYHIGH. With double quotes.","enum":["VERYLOW","LOW","NORMAL","HIGH","VERYHIGH"]}}},"DocumentLineExemptionVerifactuPost":{"required":["line-id","verifactu-exemption-cause"],"type":"object","properties":{"line-id":{"type":"integer","description":"Existing document line id with zero tax value in current ordinary or refund invoice. Without quotes.","format":"int64"},"verifactu-exemption-cause":{"type":"string","description":"Verifactu exemption cause for zero tax in the line id. With double quotes.","enum":["S2","N1","N2","E1","E2","E3","E4","E5","E6","E7","E8"]}},"description":"You must include the verifactu exemption causes array for the zero tax value lines in de ordinary or refund invoice."},"IssueInvoiceVerifactuPost":{"title":"IssueInvoiceVerifactu (POST)","required":["paid"],"type":"object","properties":{"paid":{"type":"boolean","description":"True or false (default false). Without quotes.","default":false},"simplified":{"type":"boolean","description":"True or false (default false). Without quotes.","default":false},"verifactu-exemption-cause-lines":{"type":"array","description":"You must include the verifactu exemption causes array for the zero tax value lines in de ordinary or refund invoice.","items":{"$ref":"#/components/schemas/DocumentLineExemptionVerifactuPost"}}}},"ItemImagePost":{"title":"ItemImage (POST)","required":["image-url","item-id"],"type":"object","properties":{"image-url":{"type":"string","description":"Non-empty url image. With double quotes."},"order":{"minimum":0,"type":"integer","description":"Missing attribute (default last position of the item images) or order of the image into the item images. Without quotes.","format":"int32"},"item-id":{"type":"integer","description":"Existing item id. Without quotes.","format":"int64"}}},"ItemRatePut":{"title":"ItemRate (PUT)","required":["item-id","price","rate-id"],"type":"object","properties":{"price":{"minimum":0,"type":"number","description":"Decimal. Without quotes.","format":"double"},"rate-id":{"type":"integer","description":"Existing rate id. Without quotes.","format":"int64"},"item-id":{"type":"integer","description":"Existing item id. Without quotes.","format":"int64"}}},"OrdinaryInvoiceReceiptPut":{"title":"OrdinaryInvoiceReceipt (PUT)","type":"object","properties":{"concept":{"maxLength":255,"type":"string","description":"Missing attribute (keep) or concept. This value cannot be set if the status of the receipt is paid. With double quotes."},"payment-term-date":{"type":"string","description":"Missing attribute (keep) or receipt payment term date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value cannot be set if the status of the receipt is paid. With double quotes.","format":"date-time"},"paid":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"payment-date":{"type":"string","description":"Missing attribute (keep) or receipt payment date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value can only be set if the status of the receipt is paid. With double quotes.","format":"date-time"},"amount":{"type":"number","description":"Missing attribute (keep) or decimal. This value cannot be set if the status of the receipt is paid. Without quotes.","format":"double"},"paid-employee-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. This value can only be set if the status of the receipt is paid. Without quotes.","format":"int64"},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). This value cannot be set if the status of the receipt is paid. Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). This value cannot be set if the status of the receipt is paid. Without quotes.","format":"int64","nullable":true}}},"DocumentAssetPost":{"title":"DocumentAsset (POST)","required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"Existing asset id. Without quotes.","format":"int64"}},"description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true},"DocumentLinePost":{"title":"DocumentLine (POST)","required":["item-id","line-type"],"type":"object","properties":{"item-name":{"maxLength":128,"type":"string","description":"Missing attribute (default we take this value from item properties). With double quotes."},"item-description":{"maxLength":2048,"type":"string","description":"Missing attribute (default we take this value from item properties). With double quotes.","nullable":true},"income-tax-enabled":{"type":"boolean","description":"True or false (default we take this value from document properties). Without quotes."},"primary-tax-id":{"type":"integer","description":"Missing attribute (default we take this value from item properties) or existing tax line id of type CONSUMPTION, takes priority over primary tax percentage. Without quotes.","format":"int64"},"warehouse-id":{"type":"integer","description":"It is only necessary to indicate this attribute if the multi-warehouse module is activated. Missing attribute (default we take this value from employee properties) or existing warehouse id. This attribute is required if the item type is PRODUCT, the PRODUCT has stock enabled an the document type is in SALESDELIVERYNOTE, WORKDELIVERYNOTE, PURCHASEDELIVERYNOTE, ORDINARYINVOICE, REFUNDINVOICE or PURCHASEINVOICE. Without quotes.","format":"int64","nullable":true},"item-id":{"type":"integer","description":"Existing service/product/expense and investment id when line type is ITEM or COMPONENT (composite products or expense and investment not allowed). Without quotes.","format":"int64"},"item-base-price":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from item properties). Without quotes.","format":"double"},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from primary-tax-id) or primary tax percentage. Without quotes.","format":"double"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from item properties). This value only is used if u pass item base price value. Without quotes.","format":"double"},"units":{"type":"number","description":"Missing attribute (default). Can be negative (can not be negative if line type is COMPONENT). Without quotes.","format":"double","default":1},"line-type":{"type":"string","description":"You must choose between ITEM, COMPONENT and SECTION (DOCUMENT cannot be used in POST and it's reserved for PUT and is system generated lines), when you choose ITEM you must indicate a valid service/product/expense and investment on item id. If SECTION is chosen some data like item id, item base price etc will be ignored, a section includes only a name and description. Line type can not be changed on DocumentoLinePut. With double quotes.","enum":["ITEM","DOCUMENT","SECTION","COMPONENT"]}},"description":"You must include at least one line of type ITEM with an item id."},"OrdinaryInvoicePost":{"title":"OrdinaryInvoice (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"payment-terms-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment term id or null (Immediate Payment). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"assets":{"type":"array","description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPost"}},"delivery-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Existing document state id: Pending (default), Draft or Paid. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type SALESESTIMATE, SALESORDER, SALESDELIVERYNOTE, WORKESTIMATE, WORKORDER or WORKDELIVERYNOTE or null (unassigned). Without quotes.","format":"int64","nullable":true},"parent-incident-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid incident or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"account-tax-identification-number":{"maxLength":30,"type":"string","description":"This information is required when the client/potential client did not have a tax identification number already set, this will never override an existing tax number of the account, we will only set it when it is empty. With double quotes."},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"DocumentAssetPut":{"title":"DocumentAsset (PUT)","required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"Existing asset id. Without quotes.","format":"int64"}},"description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true},"DocumentLinePut":{"title":"DocumentLine (PUT)","type":"object","properties":{"item-name":{"maxLength":128,"type":"string","description":"Missing attribute (keep or we take this value from item properties when setting a different item) or name. With double quotes."},"item-description":{"maxLength":2048,"type":"string","description":"Missing attribute (keep or we take this value from item properties when setting a different item), null/\"\" (empty) or description. With double quotes.","nullable":true},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false (default false). Without quotes."},"primary-tax-id":{"type":"integer","description":"Missing attribute (keep or we take this value from item properties when setting a different item) or existing tax line id of type CONSUMPTION, takes priority over primary tax percentage. Without quotes.","format":"int64"},"warehouse-id":{"type":"integer","description":"It is only necessary to indicate this attribute if the multi-warehouse module is activated. Missing attribute (keep) or existing warehouse id. This attribute is required if the item type is PRODUCT, the PRODUCT has stock enabled an the document type is in SALESDELIVERYNOTE, WORKDELIVERYNOTE, PURCHASEDELIVERYNOTE, ORDINARYINVOICE, REFUNDINVOICE or PURCHASEINVOICE. Without quotes.","format":"int64","nullable":true},"item-id":{"type":"integer","description":"Missing attribute (keep) or existing service/product/expense and investment id when line type is ITEM or COMPONENT (composite products or expense and investment not allowed). Without quotes.","format":"int64"},"item-base-price":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from item properties when setting a different item) or decimal. Without quotes.","format":"double"},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from item properties when setting a different item) or decimal. Without quotes.","format":"double"},"units":{"type":"number","description":"Missing attribute (keep) or decimal. Can be negative (can not be negative if line type is COMPONENT). Without quotes.","format":"double"}},"description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document."},"OrdinaryInvoicePut":{"title":"OrdinaryInvoice (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Missing attribute (keep), document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"payment-terms-id":{"type":"integer","description":"Missing attribute (keep), existing payment term id or null (Immediate Payment). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"assets":{"type":"array","description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPut"}},"delivery-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing ordinary invoice state id: Pending, Draft or Paid. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"account-tax-identification-number":{"maxLength":30,"type":"string","description":"This information is required when the client/potential client did not have a tax identification number already set, this will never override an existing tax number of the account, we will only set it when it is empty. With double quotes."},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"PaymentOptionPost":{"title":"PaymentOption (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Non-empty name for the asset. With double quotes."},"description":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true},"default":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","nullable":true,"default":false},"linked-to-bank-account":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","nullable":true,"default":false},"subject-to-sepa-payment":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","nullable":true,"default":false}}},"PaymentOptionPut":{"title":"PaymentOption (PUT)","type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"description":{"maxLength":512,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true},"default":{"type":"boolean","description":"Missing attribute (keep), true or false. Without quotes."},"linked-to-bank-account":{"type":"boolean","description":"Missing attribute (keep), true or false. Without quotes."},"subject-to-sepa-payment":{"type":"boolean","description":"Missing attribute (keep), true or false. Without quotes."}}},"PotentialClientPost":{"title":"PotentialClient (POST)","required":["legal-name"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"legal-name":{"maxLength":128,"type":"string","description":"Non-empty legal name for the potential client. With double quotes."},"name":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"tax-identification-number":{"maxLength":30,"type":"string","description":"With double quotes.","nullable":true},"phone":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"phone2":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Valid email, we will check the format. With double quotes.","nullable":true},"website":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true},"comments":{"maxLength":4096,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from CONSUMPTION sales tax settings), true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from CONSUMPTION sales tax settings), true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute or valid countable account. With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"agent-id":{"type":"integer","description":"Existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"rate-id":{"type":"integer","description":"Existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-category-id":{"type":"integer","description":"Existing account category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"main-address":{"$ref":"#/components/schemas/MainAddressPost"},"payment-terms-id":{"type":"integer","description":"Existing payment term id or null (Inmediate Payment). Without quotes.","format":"int64","nullable":true},"payment-day":{"maximum":31,"minimum":1,"type":"integer","description":"Day number 1 to 31. Without quotes. If a day is passed you must choose payment-adjustment too (PREVIOUS, LATER, CLOSEST).","format":"int32"},"invoice-to-account-id":{"type":"integer","description":"Existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing we use the default serial number of this kind of object. If you want to use MANUAL reference then use -2.","format":"int64"},"payment-adjustment":{"type":"string","description":"One of these values if you define a payment-day (PREVIOUS, LATER, CLOSEST). With double quotes.","enum":["UNDEFINED","PREVIOUS","LATER","CLOSEST"],"default":"UNDEFINED"},"currency-code":{"type":"string","description":"Missing attribute (default we take this value from my business settings) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from payment options settings), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"PotentialClientPut":{"title":"PotentialClient (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one, you cant leave it null or empty when MANUAL serial number is chosen). If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"legal-name":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"name":{"maxLength":128,"type":"string","description":"Missing attribute (keep), name or null/\"\" (empty). With double quotes.","nullable":true},"tax-identification-number":{"maxLength":30,"type":"string","description":"Missing attribute (keep), tax identification number or null/\"\" (empty). With double quotes.","nullable":true},"phone":{"maxLength":32,"type":"string","description":"Missing attribute (keep), phone or null/\"\" (empty). With double quotes.","nullable":true},"phone2":{"maxLength":32,"type":"string","description":"Missing attribute (keep), phone or null/\"\" (empty). With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"Missing attribute (keep), fax or null/\"\" (empty). With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Missing attribute (keep), valid email or null/\"\" (empty). With double quotes.","nullable":true},"website":{"maxLength":512,"type":"string","description":"Missing attribute (keep), website or null/\"\" (empty). With double quotes.","nullable":true},"comments":{"maxLength":4096,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid countable account or null/\"\" (empty). With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"agent-id":{"type":"integer","description":"Missing attribute (keep), existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"rate-id":{"type":"integer","description":"Missing attribute (keep), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-category-id":{"type":"integer","description":"Missing attribute (keep), existing account category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"main-address":{"$ref":"#/components/schemas/MainAddressPut"},"payment-terms-id":{"type":"integer","description":"Missing attribute (keep), existing payment terms id or null (Inmediate Payment). Without quotes.","format":"int64","nullable":true},"payment-day":{"maximum":31,"minimum":1,"type":"integer","description":"Missing attribute (keep), null (unassigned) or day 1 to 31. Without quotes. If a day is passed you must choose payment-adjustment too (PREVIOUS, LATER, CLOSEST)","format":"int32"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (keep), existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes. If you want to use MANUAL reference then use -2.","format":"int64"},"payment-adjustment":{"type":"string","description":"Missing attribute (keep) or one of these values if you define a payment-day (PREVIOUS, LATER, CLOSEST). With double quotes.","enum":["UNDEFINED","PREVIOUS","LATER","CLOSEST"]},"currency-code":{"type":"string","description":"Missing attribute (keep) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"ProductCategoryPost":{"title":"ProductCategory (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Non-empty name for the product category. With double quotes."},"description":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true}}},"ProductCategoryPut":{"title":"ProductCategory (PUT)","type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"description":{"maxLength":512,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true}}},"ProductComponentPost":{"title":"ProductComponent (POST)","required":["component-id","item-id"],"type":"object","properties":{"order":{"minimum":0,"type":"integer","description":"Missing attribute (default last position of the product components) or order of the component into the product components. Without quotes.","format":"int32"},"units":{"minimum":0.000010,"type":"number","description":"Missing attribute (default). Must be higher than 0. Without quotes.","format":"double","default":1},"item-id":{"type":"integer","description":"Existing composite product id. Without quotes.","format":"int64"},"component-id":{"type":"integer","description":"Existing item id. Without quotes.","format":"int64"}}},"ProductComponentPut":{"title":"ProductComponent (PUT)","type":"object","properties":{"units":{"minimum":0.000010,"type":"number","description":"Missing attribute (keep). Must be higher than 0. Without quotes.","format":"double","default":1}}},"ProductWarehousePut":{"title":"ProductWarehouse (PUT)","required":["item-id","warehouse-id"],"type":"object","properties":{"location":{"maxLength":256,"type":"string","description":"Missing attribute (keep), location or null/\"\" (empty). With double quotes.","nullable":true},"warehouse-id":{"type":"integer","description":"Existing warehouse id. Without quotes.","format":"int64"},"item-id":{"type":"integer","description":"Existing product id. Without quotes.","format":"int64"},"real-stock":{"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"minimum-stock":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"}}},"ProductPost":{"title":"Product (POST)","required":["name"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing attribute or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"Non-empty name for the product. With double quotes."},"barcode":{"maxLength":256,"type":"string","description":"With double quotes.","nullable":true},"description":{"maxLength":2048,"type":"string","description":"With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"With double quotes.","nullable":true},"sales-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the product sale countable account from accounting settings) or valid sales countable account. With double quotes.","nullable":true},"purchase-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the purchase countable account from accounting settings) or valid purchase countable account. With double quotes.","nullable":true},"margin-enabled":{"type":"boolean","description":"Missing attribute (default), true or false . Without quotes.","default":false},"promotional":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"inactive":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"stock-enabled":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"location":{"maxLength":256,"type":"string","description":"With double quotes.","nullable":true},"composite":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"primary-tax-id":{"type":"integer","description":"Missing attribute (default we take this value from CONSUMPTION tax settings), null (do not apply) or existing tax line id of type CONSUMPTION. Takes priority over primary tax percentage. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object. If you want to use MANUAL reference then use -2.","format":"int64"},"sales-margin-percentage":{"maximum":99.99,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from primary-tax-id) or primary tax percentage. Without quotes.","format":"double"},"purchase-price":{"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"sales-minimum-price":{"minimum":0,"type":"number","description":"Missing attribute (default). The minimum sales price can not be higher than the sales price minus the discount percentage. Without quotes.","format":"double","default":0},"real-stock":{"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"sales-price":{"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"purchase-margin-percentage":{"minimum":-99.99,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"minimum-stock":{"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"composite-margin-sales-price":{"minimum":0.000010,"type":"number","description":"Missing attribute (default we take the composite margin sales price from composite products settings) or composite margin sales price. Without quotes.","format":"double","default":1},"product-category-id":{"type":"integer","description":"Existing product category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"composite-sales-price":{"type":"string","description":"Missing attribute (default we take the composite sales price from composite products settings) or composite sales price. With double quotes.","enum":["PRICE","SUM_SALES_PRICES","SUM_PURCHASE_PRICES"],"default":"PRICE"},"composite-pdf-behavior":{"type":"string","description":"Missing attribute (default we take the composite pdf behavior from composite products settings) or composite pdf behavior. With double quotes.","enum":["SHOW_WITHOUT_VALUES","SHOW","HIDE"]},"composite-document-behavior":{"type":"string","description":"Missing attribute (default we take the composite document behavior from composite products settings) or composite document behavior. With double quotes.","enum":["SHOW","SHOW_AND_BLOCK","HIDE"]}}},"ProductPut":{"title":"Product (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one, you cant leave it null or empty when MANUAL serial number is chosen). If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing attribute or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or name. With double quotes."},"barcode":{"maxLength":256,"type":"string","description":"Missing attribute (keep), barcode or null/\"\" (empty). With double quotes.","nullable":true},"description":{"maxLength":2048,"type":"string","description":"Missing attribute (keep), description or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"Missing attribute (keep), private comment or null/\"\" (empty). With double quotes.","nullable":true},"sales-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid sales countable account or null/\"\" (empty). With double quotes.","nullable":true},"purchase-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid purchase countable account or null/\"\" (empty). With double quotes.","nullable":true},"margin-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"promotional":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"inactive":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"stock-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"location":{"maxLength":256,"type":"string","description":"Missing attribute (keep), location or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-id":{"type":"integer","description":"Missing attribute (keep) or existing tax line id of type CONSUMPTION, takes priority over primary tax percentage. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes. If you want to use MANUAL reference then use -2.","format":"int64"},"sales-margin-percentage":{"maximum":99.99,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"purchase-price":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"sales-minimum-price":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. The minimum sales price can not be higher than the sales price minus the discount percentage. Without quotes.","format":"double"},"real-stock":{"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"sales-price":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"purchase-margin-percentage":{"minimum":-99.99,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"minimum-stock":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"composite-margin-sales-price":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"product-category-id":{"type":"integer","description":"Missing attribute (keep), existing product category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"composite-sales-price":{"type":"string","description":"Missing attribute (keep) or composite sales price. With double quotes.","enum":["PRICE","SUM_SALES_PRICES","SUM_PURCHASE_PRICES"],"default":"PRICE"},"composite-pdf-behavior":{"type":"string","description":"Missing attribute (keep) or composite pdf behavior. With double quotes.","enum":["SHOW_WITHOUT_VALUES","SHOW","HIDE"]},"composite-document-behavior":{"type":"string","description":"Missing attribute (keep) or composite document behavior. With double quotes.","enum":["SHOW","SHOW_AND_BLOCK","HIDE"]}}},"PurchaseDeliveryNotePost":{"title":"PurchaseDeliveryNote (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"extra-reference":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"account-id":{"type":"integer","description":"Existing supplier id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the purchase delivery note state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type PURCHASEORDER or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"PurchaseDeliveryNotePut":{"title":"PurchaseDeliveryNote (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"extra-reference":{"maxLength":128,"type":"string","description":"Missing attribute (keep), extra-reference or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Missing attribute (keep), document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing supplier id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing purchase delivery note state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"PurchaseInvoiceReceiptPut":{"title":"PurchaseInvoiceReceipt (PUT)","type":"object","properties":{"concept":{"maxLength":255,"type":"string","description":"Missing attribute (keep) or concept. This value cannot be set if the status of the receipt is paid With double quotes."},"payment-term-date":{"type":"string","description":"Missing attribute (keep) or receipt payment term date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value cannot be set if the status of the receipt is paid With double quotes.","format":"date-time"},"paid":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"payment-date":{"type":"string","description":"Missing attribute (keep) or receipt payment date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value can only be set if the status of the receipt is paid. With double quotes.","format":"date-time"},"amount":{"type":"number","description":"Missing attribute (keep) or decimal. This value cannot be set if the status of the receipt is paid Without quotes.","format":"double"},"paid-employee-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. This value can only be set if the status of the receipt is paid. Without quotes.","format":"int64"},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). This value cannot be set if the status of the receipt is paid Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). This value cannot be set if the status of the receipt is paid Without quotes.","format":"int64","nullable":true}}},"PurchaseInvoicePost":{"title":"PurchaseInvoice (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes."},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes."},"extra-reference":{"maxLength":128,"type":"string","description":"With double quotes."},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time"},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"account-id":{"type":"integer","description":"Existing supplier id. Without quotes.","format":"int64"},"payment-terms-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment term id or null (Immediate Payment). Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64"},"document-state-id":{"type":"integer","description":"Existing document state id: Pending (default) or Paid. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type PURCHASEORDER or PURCHASEDELIVERYNOTE or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64"},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"PurchaseInvoicePut":{"title":"PurchaseInvoice (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"extra-reference":{"maxLength":128,"type":"string","description":"Missing attribute (keep), extra-reference or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Missing attribute (keep), document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing supplier id. Without quotes.","format":"int64"},"payment-terms-id":{"type":"integer","description":"Missing attribute (keep), existing payment term id or null (Immediate Payment). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing purchase invoice state id: Pending (default) or Paid. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"PurchaseOrderPost":{"title":"PurchaseOrder (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"extra-reference":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (emty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"account-id":{"type":"integer","description":"Existing supplier id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the purchase order state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"PurchaseOrderPut":{"title":"PurchaseOrder (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"extra-reference":{"maxLength":128,"type":"string","description":"Missing attribute (keep), extra-reference or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Missing attribute (keep), document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing supplier id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing purchase order state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"RatePost":{"title":"RatePost (POST)","required":["name"],"type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Non-empty name for the rate. With double quotes."},"description":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true}}},"RatePut":{"title":"Rate (PUT)","type":"object","properties":{"name":{"maxLength":32,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"description":{"maxLength":512,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true}}},"RefundInvoiceReceiptPut":{"title":"RefundInvoiceReceipt (PUT)","type":"object","properties":{"concept":{"maxLength":255,"type":"string","description":"Missing attribute (keep) or concept. This value cannot be set if the status of the receipt is paid With double quotes."},"payment-term-date":{"type":"string","description":"Missing attribute (keep) or receipt payment term date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value cannot be set if the status of the receipt is paid With double quotes.","format":"date-time"},"paid":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"payment-date":{"type":"string","description":"Missing attribute (keep) or receipt payment date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". This value can only be set if the status of the receipt is paid. With double quotes.","format":"date-time"},"amount":{"type":"number","description":"Missing attribute (keep) or decimal. This value cannot be set if the status of the receipt is paid Without quotes.","format":"double"},"paid-employee-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. This value can only be set if the status of the receipt is paid. Without quotes.","format":"int64"},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). This value cannot be set if the status of the receipt is paid Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). This value cannot be set if the status of the receipt is paid Without quotes.","format":"int64","nullable":true}}},"RefundInvoicePost":{"title":"RefundInvoice (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"payment-terms-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment term id or null (Immediate Payment). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"assets":{"type":"array","description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPost"}},"delivery-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Existing document state id: Pending (default), Draft or Paid. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type ORDINARYINVOICE or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"account-tax-identification-number":{"maxLength":30,"type":"string","description":"This information is required when the client/potential client did not have a tax identification number already set, this will never override an existing tax number of the account, we will only set it when it is empty. With double quotes."},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"RefundInvoicePut":{"title":"RefundInvoice (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Missing attribute (keep), document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"payment-terms-id":{"type":"integer","description":"Missing attribute (keep), existing payment term id or null (Immediate Payment). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"assets":{"type":"array","description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPut"}},"delivery-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing refund invoice state id: Pending, Draft or Paid. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"account-tax-identification-number":{"maxLength":30,"type":"string","description":"This information is required when the client/potential client did not have a tax identification number already set, this will never override an existing tax number of the account, we will only set it when it is empty. With double quotes."},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"SalesDeliveryNotePost":{"title":"SalesDeliveryNote (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"delivery-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the sales delivery note state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type SALESESTIMATE or SALESORDER or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"SalesDeliveryNotePut":{"title":"SalesDeliveryNote (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Missing attribute (keep), document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"delivery-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing sales delivery note state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"SalesEstimatePost":{"title":"SalesEstimate (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"validity-date":{"type":"string","description":"Document validity date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"delivery-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the sales estimate state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"SalesEstimatePut":{"title":"SalesEstimate (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"validity-date":{"type":"string","description":"Missing attribute (keep), document validity date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"delivery-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing sales estimate state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"SalesOrderPost":{"title":"SalesOrder (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"delivery-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the sales order state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type SALESESTIMATE or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"SalesOrderPut":{"title":"SalesOrder (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"sent-date":{"type":"string","description":"Missing attribute (keep), document sent date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"delivery-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing sales order state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"SendDocumentPut":{"title":"SendDocument (PUT)","type":"object","properties":{"email":{"type":"string","description":"Missing attribute (default we take this value from the document account), or valid email, we will check the format. With double quotes."}}},"ServicePost":{"title":"Service (POST)","required":["name"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing attribute or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"Non-empty name for the service. With double quotes."},"description":{"maxLength":2048,"type":"string","description":"With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"With double quotes.","nullable":true},"sales-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the service sale countable account from accounting settings) or valid sales countable account. With double quotes.","nullable":true},"purchase-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the purchase countable account from accounting settings) or valid purchase countable account. With double quotes.","nullable":true},"margin-enabled":{"type":"boolean","description":"Missing attribute (default), true or false . Without quotes.","default":false},"promotional":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"inactive":{"type":"boolean","description":"Missing attribute (default), True or false. Without quotes.","default":false},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-id":{"type":"integer","description":"Missing attribute (default we take this value from CONSUMPTION tax settings), null (do not apply) or existing tax line id of type CONSUMPTION. Takes priority over primary tax percentage. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object. If you want to use MANUAL reference then use -2.","format":"int64"},"sales-margin-percentage":{"maximum":99.99,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from primary-tax-id). Without quotes.","format":"double"},"purchase-price":{"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"sales-minimum-price":{"minimum":0,"type":"number","description":"Missing attribute (default). The minimum sales price can not be higher than the sales price minus the discount percentage. Without quotes.","format":"double","default":0},"sales-price":{"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"purchase-margin-percentage":{"minimum":-99.99,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0}}},"ServicePut":{"title":"Service (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one, you cant leave it null or empty when MANUAL serial number is chosen). If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing attribute or an existing serial number id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"name":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or name. With double quotes."},"description":{"maxLength":2048,"type":"string","description":"Missing attribute (keep), description or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":50000,"type":"string","description":"Missing attribute (keep), private comment or null/\"\" (empty). With double quotes.","nullable":true},"sales-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid sales countable account or null/\"\" (empty). With double quotes.","nullable":true},"purchase-countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid purchase countable account or null/\"\" (empty). With double quotes.","nullable":true},"margin-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"promotional":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"inactive":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-id":{"type":"integer","description":"Missing attribute (keep) or existing tax line id of type CONSUMPTION, takes priority over primary tax percentage. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes. If you want to use MANUAL reference then use -2.","format":"int64"},"sales-margin-percentage":{"maximum":99.99,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"primary-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"purchase-price":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"sales-minimum-price":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. The minimum sales price can not be higher than the sales price minus the discount percentage. Without quotes.","format":"double"},"sales-price":{"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"purchase-margin-percentage":{"minimum":-99.99,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"}}},"SpecialPricePost":{"title":"ItemRate (POST)","required":["account-id","item-id","price"],"type":"object","properties":{"price":{"minimum":0,"type":"number","description":"Decimal. Without quotes.","format":"double"},"item-supplier-reference":{"maxLength":255,"type":"string","description":"This value only is used if the account is a Supplier. With double quotes","nullable":true},"account-id":{"type":"integer","description":"Existing account id. Without quotes.","format":"int64"},"item-id":{"type":"integer","description":"Existing item id. Without quotes.","format":"int64"}}},"SpecialPricePut":{"title":"ItemRate (PUT)","required":["price"],"type":"object","properties":{"price":{"minimum":0,"type":"number","description":"Decimal. Without quotes.","format":"double"},"item-supplier-reference":{"maxLength":255,"type":"string","description":"Missing attribute (keep), item reference supplier or null/\"\" (empty). This value only is used if the account is a Supplier. With double quotes.","nullable":true}}},"SupplierPost":{"title":"Supplier (POST)","required":["legal-name"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing or an existing serial-number-id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"legal-name":{"maxLength":128,"type":"string","description":"Non-empty legal name for the supplier. With double quotes."},"name":{"maxLength":128,"type":"string","description":"With double quotes.","nullable":true},"tax-identification-number":{"maxLength":30,"type":"string","description":"With double quotes.","nullable":true},"phone":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"phone2":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Valid email, we will check the format. With double quotes.","nullable":true},"website":{"maxLength":512,"type":"string","description":"With double quotes.","nullable":true},"comments":{"maxLength":4096,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from CONSUMPTION purchase tax settings), true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from CONSUMPTION purchase tax settings), true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default), true or false. Without quotes.","default":false},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (default we take the next client account from accounting settings) or valid countable account. With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"With double quotes.","nullable":true},"agent-id":{"type":"integer","description":"Existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-category-id":{"type":"integer","description":"Existing account category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"main-address":{"$ref":"#/components/schemas/MainAddressPost"},"payment-terms-id":{"type":"integer","description":"Existing payment term id or null (Inmediate Payment). Without quotes.","format":"int64","nullable":true},"payment-day":{"maximum":31,"minimum":1,"type":"integer","description":"Day number 1 to 31. Without quotes. If a day is passed you must choose payment-adjustment too (PREVIOUS, LATER, CLOSEST).","format":"int32"},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing we use the default serial number of this kind of object. If you want to use MANUAL reference then use -2.","format":"int64"},"payment-adjustment":{"type":"string","description":"One of these values if you define a payment-day (PREVIOUS, LATER, CLOSEST). With double quotes.","enum":["UNDEFINED","PREVIOUS","LATER","CLOSEST"],"default":"UNDEFINED"},"currency-code":{"type":"string","description":"Missing attribute (default we take this value from my business settings) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from payment options settings), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"SupplierPut":{"title":"Supplier (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one, you cant leave it null or empty when MANUAL serial number is chosen). If you choose MANUAL reference on serial number id you must choose a numeric or non numeric reference (with no uniqueness restriction), if you choose null, missing or an existing serial-number-id you can leave this field null (system will save the object with the next reference of the serial) or choose an unique and valid reference number. With double quotes.","nullable":true},"legal-name":{"maxLength":128,"type":"string","description":"Missing attribute (keep) or legal name. With double quotes."},"name":{"maxLength":128,"type":"string","description":"Missing attribute (keep), name or null/\"\" (empty). With double quotes.","nullable":true},"tax-identification-number":{"maxLength":30,"type":"string","description":"Missing attribute (keep), tax identification number or null/\"\" (empty). With double quotes.","nullable":true},"phone":{"maxLength":32,"type":"string","description":"Missing attribute (keep), phone or null/\"\" (empty). With double quotes.","nullable":true},"phone2":{"maxLength":32,"type":"string","description":"Missing attribute (keep), phone or null/\"\" (empty). With double quotes.","nullable":true},"fax":{"maxLength":32,"type":"string","description":"Missing attribute (keep), fax or null/\"\" (empty). With double quotes.","nullable":true},"email":{"maxLength":320,"type":"string","description":"Missing attribute (keep), valid email or null/\"\" (empty). With double quotes.","nullable":true},"website":{"maxLength":512,"type":"string","description":"Missing attribute (keep), website or null/\"\" (empty). With double quotes.","nullable":true},"comments":{"maxLength":4096,"type":"string","description":"Missing attribute (keep), comments or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep) or true/false. Without quotes."},"countable-account":{"maxLength":12,"type":"string","description":"Missing attribute (keep), valid countable account or null/\"\" (empty). With double quotes.","nullable":true},"external-id":{"maxLength":64,"type":"string","description":"Missing attribute (keep), external id or null/\"\" (empty). With double quotes.","nullable":true},"agent-id":{"type":"integer","description":"Missing attribute (keep), existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-category-id":{"type":"integer","description":"Missing attribute (keep), existing account category id or null (unassigned). Without quotes.","format":"int64","nullable":true},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"main-address":{"$ref":"#/components/schemas/MainAddressPut"},"payment-terms-id":{"type":"integer","description":"Missing attribute (keep), existing payment terms id or null (Inmediate Payment). Without quotes.","format":"int64","nullable":true},"payment-day":{"maximum":31,"minimum":1,"type":"integer","description":"Missing attribute (keep), null (unassigned) or day 1 to 31. Without quotes. If a day is passed you must choose payment-adjustment too (PREVIOUS, LATER, CLOSEST).","format":"int32"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes. If you want to use MANUAL reference then use -2.","format":"int64"},"payment-adjustment":{"type":"string","description":"Missing attribute (keep) or one of these values if you define a payment-day (PREVIOUS, LATER, CLOSEST). With double quotes.","enum":["UNDEFINED","PREVIOUS","LATER","CLOSEST"]},"currency-code":{"type":"string","description":"Missing attribute (keep) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"payment-option-id":{"type":"integer","description":"Missing attribute (keep), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true}}},"WorkDeliveryNotePost":{"title":"WorkDeliveryNote (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"due-date":{"type":"string","description":"Document due date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"start-date":{"type":"string","description":"Document start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"end-date":{"type":"string","description":"Document end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"assets":{"type":"array","description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPost"}},"work-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (default unassigned), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the work delivery note state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type WORKESTIMATE or WORKORDER or null (unassigned). Without quotes.","format":"int64","nullable":true},"parent-incident-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid incident or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"WorkDeliveryNotePut":{"title":"WorkDeliveryNote (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"due-date":{"type":"string","description":"Missing attribute (keep), document due date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"start-date":{"type":"string","description":"Missing attribute (keep), document start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"end-date":{"type":"string","description":"Missing attribute (keep), document end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), null (unassigned) or existing client/potential cliente id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"assets":{"type":"array","description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPut"}},"work-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing work delivery note state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"WorkEstimatePost":{"title":"WorkEstimate (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"validity-date":{"type":"string","description":"Document validity date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"assets":{"type":"array","description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPost"}},"work-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the work estimate state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"parent-incident-id":{"type":"integer","description":"Missing attribute (default), existing valid incident or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"WorkEstimatePut":{"title":"WorkEstimate (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"validity-date":{"type":"string","description":"Missing attribute (keep), document validity date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), null (unassigned) or existing client/potential cliente id. Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"assets":{"type":"array","description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPut"}},"work-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing work estimate state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}},"WorkOrderPost":{"title":"WorkOrder (POST)","required":["account-id","lines"],"type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Unique and valid reference number. If you choose null or missing attribute the system will save the object with the next reference of the serial (chosen or default). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or comments. With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (default we take this value from serial number properties) or addendum.With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (default we take this value from account properties) or true or false. Without quotes."},"date":{"type":"string","description":"Missing attribute (default now) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"due-date":{"type":"string","description":"Document due date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"start-date":{"type":"string","description":"Document start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"end-date":{"type":"string","description":"Document end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (default we take this value from European Central Bank). Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Existing client/potential client id. Without quotes.","format":"int64"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing client/potential client id or null (unassigned). Without quotes.","format":"int64","nullable":true},"serial-number-id":{"type":"integer","description":"Existing serial number id for this kind of entity. Without quotes, if you choose null or missing attribute we use the default serial number of this kind of object.","format":"int64"},"assets":{"type":"array","description":"Missing attribute or null (empty) or JSON Array with existing assets ids.","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPost"}},"work-address-id":{"type":"integer","description":"Missing attribute (default we take the account delivery address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (default we take the w order state with lower order) or existing sales estimate state state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default we take this value from account properties). Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (default). Without quotes.","format":"double","default":0},"agent-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties) or existing employee id. Without quotes.","format":"int64"},"assignee-id":{"type":"integer","description":"Missing attribute (default we take this value from API employee), existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"parent-document-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid document of type WORKESTIMATE or null (unassigned). Without quotes.","format":"int64","nullable":true},"parent-incident-id":{"type":"integer","description":"Missing attribute (default unassigned), existing valid incident or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (default we take the value from account properties) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (default we take the account invoicing address or default address), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (default we take this value from account properties), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (default we take this value from bank accounts settings), existing bank-account id or null (unassigned). We will only set it when the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"You must include at least one line of type ITEM with an item id.","items":{"$ref":"#/components/schemas/DocumentLinePost"}}}},"WorkOrderPut":{"title":"WorkOrder (PUT)","type":"object","properties":{"reference":{"maxLength":32,"type":"string","description":"Missing attribute (keep), a valid reference or null/\"\" (autogenerate new one). With double quotes.","nullable":true},"comments":{"maxLength":30000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), comments or null/\"\" (empty). With double quotes.","nullable":true},"private-comments":{"maxLength":20000,"type":"string","description":"Missing attribute (keep), private comments or null/\"\" (empty). With double quotes.","nullable":true},"addendum":{"maxLength":20000,"type":"string","description":"Missing attribute (keep or we take this value from serial number properties when setting a different serial number), addendum or null/\"\" (empty). With double quotes.","nullable":true},"title":{"maxLength":220,"type":"string","description":"Missing attribute (keep), title or null/\"\" (empty). With double quotes.","nullable":true},"primary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"secondary-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"income-tax-enabled":{"type":"boolean","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or true/false. Without quotes."},"date":{"type":"string","description":"Missing attribute (keep) or document date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\". With double quotes.","format":"date-time"},"due-date":{"type":"string","description":"Missing attribute (keep), document due date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"start-date":{"type":"string","description":"Missing attribute (keep), document start date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"end-date":{"type":"string","description":"Missing attribute (keep), document end date in this format: \"yyyy-MM-dd'T'HH:mm:ssZ\" or null (empty). With double quotes.","format":"date-time","nullable":true},"currency-rate":{"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from European Central Bank when setting a different currency-code) or decimal. Without quotes.","format":"double"},"creator-id":{"type":"integer","description":"Missing attribute (keep) or existing employee id. Without quotes.","format":"int64"},"rate-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing rate id or null (unassigned). Without quotes.","format":"int64","nullable":true},"account-id":{"type":"integer","description":"Missing attribute (keep) or existing client/potential client id. Without quotes.","format":"int64"},"invoice-to-account-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), null (unassigned) or existing client/potential cliente id. Without quotes.","format":"int64"},"serial-number-id":{"type":"integer","description":"Missing attribute (keep) or existing serial number id for this kind of entity. Without quotes.","format":"int64"},"assets":{"type":"array","description":"Missing attribute (keep), JSON Array with existing assets ids or null (empty).","nullable":true,"items":{"$ref":"#/components/schemas/DocumentAssetPut"}},"work-address-id":{"type":"integer","description":"Missing attribute (keep or the account delivery address when setting a different account), existing delivery id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"delivery-option-id":{"type":"integer","description":"Missing attribute (keep), existing delivery option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"document-state-id":{"type":"integer","description":"Missing attribute (keep) or existing work order state id. Without quotes.","format":"int64"},"discount-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or decimal. Without quotes.","format":"double"},"income-tax-percentage":{"maximum":100,"minimum":0,"type":"number","description":"Missing attribute (keep) or decimal. Without quotes.","format":"double"},"agent-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or existing employee id. Without quotes.","format":"int64"},"assignee-id":{"type":"integer","description":"Missing attribute (keep), existing employee id or null (unassigned). Without quotes.","format":"int64","nullable":true},"currency-code":{"type":"string","description":"Missing attribute (keep or we take this value from account properties when setting a different account) or ISO 3 character currency code like EUR or USD. With double quotes.","enum":["EUR","USD","GBP","ARS","CLP","MXN","UYU","COP","PEN","AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLF","CNY","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMK","ZWL"]},"invoicing-address-id":{"type":"integer","description":"Missing attribute (keep or the account invoicing address or default address when setting a different account), existing address id of the selected account or null (unassigned). Without quotes.","format":"int64","nullable":true},"payment-option-id":{"type":"integer","description":"Missing attribute (keep or we take this value from account properties when setting a different account), existing payment option id or null (unassigned). Without quotes.","format":"int64","nullable":true},"bank-account-id":{"type":"integer","description":"Missing attribute (keep), existing bank account id or null (unassigned). We will only set it when it if the payment option is linked to bank account. Without quotes.","format":"int64","nullable":true},"lines":{"type":"array","description":"Missing attribute (keep) or collection of all document lines. If present, it must have all the lines, we will delete all lines and recreate it with provided ones. You must include at least one line of type ITEM with an item id for the new lines or a line id of an existing line to modify it or keep it in the document.","items":{"$ref":"#/components/schemas/DocumentLinePut"}}}}},"securitySchemes":{"APIKEY":{"type":"apiKey","name":"APIKEY","in":"header"}}}}