{ "info": { "name": "Evyoo POS API", "description": "Collection for the Evyoo POS API (v1.0.0).\n\n1. Fill the collection variables: baseUrl (your company address), clientId (access key) and clientSecret (security code).\n2. Run \"Get an access token\" once: the token is stored for you and expires after 15 minutes.\n3. Run any other request.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://your-company.evyooht.com/api/v1" }, { "key": "clientId", "value": "" }, { "key": "clientSecret", "value": "" }, { "key": "accessToken", "value": "" } ], "item": [ { "name": "Getting started", "description": "Check the connection, get an access token and discover what you can read.", "item": [ { "name": "Check that the API answers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/status", "host": [ "{{baseUrl}}" ], "path": [ "status" ], "query": [], "variable": [] }, "description": "Public: no token needed. This is the first call to make, to know whether you talk to the right server.\n\n`authorization_header_received` tells whether an `Authorization` header reached the server (some hosting setups remove it). Send `Authorization: Bearer x` to test it. `enabled` is false when your company has not subscribed to the API.", "auth": { "type": "noauth" } } }, { "name": "Get an access token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "token" ], "query": [], "variable": [] }, "description": "Exchange your access key and security code for a token valid for 15 minutes (OAuth 2.0 client credentials).\n\nEach successful call creates a new token and the previous ones stay valid until they expire: keep your token and reuse it, and ask for a new one only after a 401. Limit: 10 token requests per minute per IP address. After repeated failures the client is blocked for 15 minutes.\n\nAll errors on this route use the OAuth format: `{\"error\": \"...\", \"error_description\": \"...\"}`.", "auth": { "type": "noauth" }, "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials" }, { "key": "client_id", "value": "{{clientId}}" }, { "key": "client_secret", "value": "{{clientSecret}}" }, { "key": "scope", "value": "", "description": "Optional: permissions wanted, separated by spaces.", "disabled": true } ] } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 200) {", " pm.collectionVariables.set(\"accessToken\", pm.response.json().access_token);", "}" ] } } ] }, { "name": "Check that your token works", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ping", "host": [ "{{baseUrl}}" ], "path": [ "ping" ], "query": [], "variable": [] }, "description": "Tells whether a token is accepted, and for which client. Needs no permission: any valid token can call it." } }, { "name": "Discover what you can read", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/resources", "host": [ "{{baseUrl}}" ], "path": [ "resources" ], "query": [], "variable": [] }, "description": "Describes, for YOUR client, the resources it can read, with their fields, filters and sort fields. A resource you have no permission for is not listed, and neither is a field that needs an add-on permission you do not hold." } } ] }, { "name": "Catalog and parties", "description": "Products, customers and vendors.", "item": [ { "name": "List products, services and special or assembled items, with prices and stock", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`, `code`, `updated_at`. Default: `name`.", "disabled": true }, { "key": "status", "value": "active", "description": "active (default), inactive, or all. When omitted, only active records are listed. Allowed values: `active`, `inactive`, `all`.", "disabled": true }, { "key": "type", "value": "inventory", "description": "Filter by type. Several values can be given, separated by commas. Allowed values: `inventory`, `service`, `assembly`, `special`.", "disabled": true }, { "key": "department_id", "value": "1", "description": "Only products of this department.", "disabled": true }, { "key": "sub_department_id", "value": "1", "description": "Only products of this sub-department.", "disabled": true }, { "key": "vendor_id", "value": "1", "description": "Only records of this vendor.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the name, the code or the barcode.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "The product catalog. Only active products are listed unless you ask for `status=all` or `status=inactive`.\n\nPrices and stock are computed for you. A client with no price list restriction gets the base `price` and a `price_lists` array with the price of each of the seven price lists. A client restricted to one price list gets a single `price`: the one of its list, or the base price when the list price is zero. Stock is listed per store; for a client restricted to some stores, the totals add up those stores only." } }, { "name": "Get one product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "query": [], "variable": [ { "key": "id", "value": "463", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } }, { "name": "List customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`, `code`, `updated_at`. Default: `name`.", "disabled": true }, { "key": "status", "value": "active", "description": "active or inactive. Allowed values: `active`, `inactive`.", "disabled": true }, { "key": "customer_type_id", "value": "1", "description": "Only customers of this type.", "disabled": true }, { "key": "price_list_id", "value": "1", "description": "Only customers on this price list.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the name, the code, the company name, the phone or the e-mail.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "The customers of the company, with their type and price list. The credit limit and the balance are only returned to clients that hold the `customers:financial` permission." } }, { "name": "Get one customer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "58", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } }, { "name": "List vendors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/vendors?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "vendors" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`, `code`, `updated_at`. Default: `name`.", "disabled": true }, { "key": "status", "value": "active", "description": "active or inactive. Allowed values: `active`, `inactive`.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the company name, the code, the phone or the e-mail.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "The vendors of the company." } }, { "name": "Get one vendor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/vendors/:id", "host": [ "{{baseUrl}}" ], "path": [ "vendors", ":id" ], "query": [], "variable": [ { "key": "id", "value": "12", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } } ] }, { "name": "Sales", "description": "Quotes, sales orders, invoices, credit memos and payments received.", "item": [ { "name": "List quotes and their lines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/quotes?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `total`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "hold", "description": "hold, open, converted, void, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `hold`, `open`, `converted`, `void`, `all`.", "disabled": true }, { "key": "customer_id", "value": "1", "description": "Only records of this customer.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "currency", "value": "USD", "description": "Only documents in this currency (USD or HTG).", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the quote number or the customer name.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Sales quotes. Recent and archived quotes are returned together as one collection: totals, sorting and pagination cover both.\n\nStatuses: hold (draft, hidden by default), open, converted (turned into an order or an invoice), void. A void quote keeps its identity but its amounts are zero." } }, { "name": "Get one quote", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/quotes/:id", "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "1087", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines. A record that does not exist, or that your client may not see (for example another store), answers 404." } }, { "name": "List sales orders, their lines and payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales-orders?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "sales-orders" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `total`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "new", "description": "new, open, hold, converted, refunded, closed, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `new`, `open`, `hold`, `converted`, `refunded`, `closed`, `all`.", "disabled": true }, { "key": "customer_id", "value": "1", "description": "Only records of this customer.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "currency", "value": "USD", "description": "Only documents in this currency (USD or HTG).", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the order number or the customer name.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Customer sales orders.\n\nStatuses: new, open, hold (draft, hidden by default), converted (turned into an invoice), refunded, closed. For a sales order, closed is not a cancellation: amounts are kept." } }, { "name": "Get one sales order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales-orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "sales-orders", ":id" ], "query": [], "variable": [ { "key": "id", "value": "312", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines and payments. A record that does not exist, or that your client may not see (for example another store), answers 404." } }, { "name": "List invoices, their lines and payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `total`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "new", "description": "new, open, hold, regular, void, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `new`, `open`, `hold`, `regular`, `void`, `all`.", "disabled": true }, { "key": "payment_status", "value": "paid", "description": "paid or unpaid. Allowed values: `paid`, `unpaid`.", "disabled": true }, { "key": "customer_id", "value": "1", "description": "Only records of this customer.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "currency", "value": "USD", "description": "Only documents in this currency (USD or HTG).", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the invoice number, the customer name or the purchase order number.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Sales invoices. Recent and archived invoices are returned together as one collection: totals, sorting and pagination cover both.\n\nStatuses: new, open, hold (draft, hidden by default), regular (final), void. A void invoice keeps its identity (number, date, customer) but all its amounts are zero, lines and payments included, so that adding up a list never counts a cancelled sale. Quantities are kept.\n\nPayments received on an invoice later, from the customer account, are in the payments resource." } }, { "name": "Get one invoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "query": [], "variable": [ { "key": "id", "value": "4149", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines and payments. A record that does not exist, or that your client may not see (for example another store), answers 404." } }, { "name": "List credit memos and their lines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/credit-memos?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "credit-memos" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `total`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "new", "description": "new, open, hold, regular, void, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `new`, `open`, `hold`, `regular`, `void`, `all`.", "disabled": true }, { "key": "payment_status", "value": "paid", "description": "paid or unpaid. Allowed values: `paid`, `unpaid`.", "disabled": true }, { "key": "customer_id", "value": "1", "description": "Only records of this customer.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "currency", "value": "USD", "description": "Only documents in this currency (USD or HTG).", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the credit memo number, the customer name or the purchase order number.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Credit memos issued to customers. They are stored with invoices in Evyoo POS but are a separate resource here: a credit memo is not readable as an invoice, and the other way round.\n\nSame structure, statuses and rules as invoices." } }, { "name": "Get one credit memo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/credit-memos/:id", "host": [ "{{baseUrl}}" ], "path": [ "credit-memos", ":id" ], "query": [], "variable": [ { "key": "id", "value": "212", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines and payments. A record that does not exist, or that your client may not see (for example another store), answers 404." } }, { "name": "List payments received from customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "payments" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `amount_received`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "regular", "description": "regular or void. Allowed values: `regular`, `void`.", "disabled": true }, { "key": "customer_id", "value": "1", "description": "Only records of this customer.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "currency", "value": "USD", "description": "Only documents in this currency (USD or HTG).", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the payment number or the customer name.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Payments received from customers against their account (the Receive Payment module). Not to be confused with the payment of an invoice at the counter, which is part of the invoice (see the payments of an invoice).\n\nStatuses: regular, void. A void payment keeps its identity but its amounts are zero." } }, { "name": "Get one payment received", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":id" ], "query": [], "variable": [ { "key": "id", "value": "2201", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its applied_to. A record that does not exist, or that your client may not see (for example another store), answers 404." } } ] }, { "name": "Purchasing and stock", "description": "Purchase orders, receivings, transfers and adjustments.", "item": [ { "name": "List purchase orders and their lines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/purchase-orders?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "purchase-orders" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `total`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "hold", "description": "hold, open, complete, closed, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `hold`, `open`, `complete`, `closed`, `all`.", "disabled": true }, { "key": "vendor_id", "value": "1", "description": "Only records of this vendor.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "currency", "value": "USD", "description": "Only documents in this currency (USD or HTG).", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the order number or the vendor name.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Purchase orders sent to vendors.\n\nStatuses: hold (draft, hidden by default), open, complete, closed. For a purchase order, closed is not a cancellation: amounts are kept. Prices are purchase prices belonging to the document and are visible with the purchase-orders:read permission." } }, { "name": "Get one purchase order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/purchase-orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "purchase-orders", ":id" ], "query": [], "variable": [ { "key": "id", "value": "95", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines. A record that does not exist, or that your client may not see (for example another store), answers 404." } }, { "name": "List goods receivings and vendor returns", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/receivings?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "receivings" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `total`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "open", "description": "open, hold, posted, void, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `open`, `hold`, `posted`, `void`, `all`.", "disabled": true }, { "key": "type", "value": "receipt", "description": "receipt or return. Allowed values: `receipt`, `return`.", "disabled": true }, { "key": "vendor_id", "value": "1", "description": "Only records of this vendor.", "disabled": true }, { "key": "purchase_order_id", "value": "1", "description": "Only receivings linked to this purchase order.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "currency", "value": "USD", "description": "Only documents in this currency (USD or HTG).", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the receiving number, the vendor name or the vendor receipt number.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Goods received from vendors, and goods returned to them. They are stored together in Evyoo POS; the `type` field tells them apart (receipt or return), and the `type` filter reads only one kind.\n\nStatuses: open, hold (draft, hidden by default), posted, void. A void document keeps its identity but its amounts are zero. The cost fields of the lines (previous costs, average cost) require costs:read." } }, { "name": "Get one receiving", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/receivings/:id", "host": [ "{{baseUrl}}" ], "path": [ "receivings", ":id" ], "query": [], "variable": [ { "key": "id", "value": "310", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines. A record that does not exist, or that your client may not see (for example another store), answers 404." } }, { "name": "List stock transfers between stores", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "hold", "description": "hold, open, posted, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `hold`, `open`, `posted`, `all`.", "disabled": true }, { "key": "from_store_id", "value": "1", "description": "Only transfers leaving this store.", "disabled": true }, { "key": "to_store_id", "value": "1", "description": "Only transfers arriving in this store.", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the transfer number.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Transfers of stock from one store to another. A transfer involves two stores: a client restricted to some stores sees it if either the origin or the destination is allowed.\n\nStatuses: hold (draft, hidden by default), open, posted." } }, { "name": "Get one transfer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers/:id", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "48", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines. A record that does not exist, or that your client may not see (for example another store), answers 404." } }, { "name": "List quantity and cost adjustments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-date", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `updated_at`. Default: `-date`.", "disabled": true }, { "key": "status", "value": "hold", "description": "hold, posted, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `hold`, `posted`, `all`.", "disabled": true }, { "key": "type", "value": "quantity", "description": "quantity or cost. Allowed values: `quantity`, `cost`.", "disabled": true }, { "key": "store_id", "value": "1", "description": "Only documents of this store.", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "description": "Only documents dated on or after this day (YYYY-MM-DD).", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "description": "Only documents dated on or before this day (YYYY-MM-DD), the whole day included.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the adjustment number or the reason.", "disabled": true }, { "key": "updated_since", "value": "2026-03-01T00:00:00", "description": "Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).", "disabled": true } ], "variable": [] }, "description": "Stock adjustments: quantity adjustments and cost adjustments are stored together in Evyoo POS. The `type` field tells them apart (quantity or cost), and the `type` filter reads only one kind.\n\nStatuses: hold (draft, hidden by default), posted. An adjustment talks about quantities or about costs: the cost fields (the total of the document, and the costs of the lines) require costs:read." } }, { "name": "Get one adjustment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id" ], "query": [], "variable": [ { "key": "id", "value": "17", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier, with its lines. A record that does not exist, or that your client may not see (for example another store), answers 404." } } ] }, { "name": "Reference data", "description": "Stores, departments, sub-departments, price lists and customer types.", "item": [ { "name": "List stores", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "stores" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`, `code`. Default: `name`.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the store name or code.", "disabled": true } ], "variable": [] }, "description": "The stores of the company. This is where you find the name and address behind a store_id seen in a document or in a stock. A client restricted to some stores only sees those." } }, { "name": "Get one store", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores/:id", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":id" ], "query": [], "variable": [ { "key": "id", "value": "1", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } }, { "name": "List product departments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/departments?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "departments" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`, `code`. Default: `name`.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the department name or code.", "disabled": true } ], "variable": [] }, "description": "The departments products are grouped in. A product refers to its department with department_id." } }, { "name": "Get one department", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/departments/:id", "host": [ "{{baseUrl}}" ], "path": [ "departments", ":id" ], "query": [], "variable": [ { "key": "id", "value": "3", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } }, { "name": "List product sub-departments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub-departments?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "sub-departments" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`, `code`. Default: `name`.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the sub-department name or code.", "disabled": true } ], "variable": [] }, "description": "The sub-departments products are grouped in. A product refers to its sub-department with sub_department_id." } }, { "name": "Get one sub-department", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub-departments/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub-departments", ":id" ], "query": [], "variable": [ { "key": "id", "value": "21", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } }, { "name": "List price lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/price-lists?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "price-lists" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`. Default: `id`.", "disabled": true }, { "key": "status", "value": "active", "description": "active or inactive. Allowed values: `active`, `inactive`.", "disabled": true } ], "variable": [] }, "description": "The price lists (for example Retail, Distributor). The identifier is the number of the price level of a product (price_lists[].price_list_id) and the price list of a customer (price_list_id). A client restricted to one price list only sees that one." } }, { "name": "Get one price list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/price-lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "price-lists", ":id" ], "query": [], "variable": [ { "key": "id", "value": "1", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } }, { "name": "List customer types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customer-types?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "customer-types" ], "query": [ { "key": "page", "value": "1", "description": "Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Results per page, from 1 to 100.", "disabled": false }, { "key": "sort", "value": "-name", "description": "Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `name`. Default: `name`.", "disabled": true }, { "key": "search", "value": "paper", "description": "Text contained in the customer type name or code.", "disabled": true } ], "variable": [] }, "description": "The customer types. A customer refers to its type with customer_type_id." } }, { "name": "Get one customer type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customer-types/:id", "host": [ "{{baseUrl}}" ], "path": [ "customer-types", ":id" ], "query": [], "variable": [ { "key": "id", "value": "2", "description": "Identifier of the record, as returned in the `id` field of the list." } ] }, "description": "Returns one record by its identifier. A record that does not exist, or that your client may not see, answers 404." } } ] } ] }