Receivings

List goods receivings and vendor returns

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.

Statuses: 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.

needs receivings:read Purchasing and stock

Endpoints#

List: GET/api/v1/receivings One record: GET/api/v1/receivings/{id}

Example request#

List with a page size and a sort:

bash

curl "https://votre-entreprise.evyooht.com/api/v1/receivings?per_page=5&sort=-date" \
  -H "Authorization: Bearer evy_at_votre_jeton"

powershell

$headers = @{ Authorization = "Bearer evy_at_votre_jeton" }
Invoke-RestMethod -Uri "https://votre-entreprise.evyooht.com/api/v1/receivings?per_page=5&sort=-date" -Headers $headers

javascript

const response = await fetch("https://votre-entreprise.evyooht.com/api/v1/receivings?per_page=5&sort=-date", {
  headers: { Authorization: "Bearer evy_at_votre_jeton" },
});
const data = await response.json();
console.log(data);

php

$ch = curl_init("https://votre-entreprise.evyooht.com/api/v1/receivings?per_page=5&sort=-date");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer evy_at_votre_jeton"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

python

import requests

response = requests.get(
    "https://votre-entreprise.evyooht.com/api/v1/receivings",
    params={"per_page": 5, "sort": "-date"},
    headers={"Authorization": "Bearer evy_at_votre_jeton"},
)
print(response.json())

One record by its identifier:

bash

curl "https://votre-entreprise.evyooht.com/api/v1/receivings/310" \
  -H "Authorization: Bearer evy_at_votre_jeton"

powershell

$headers = @{ Authorization = "Bearer evy_at_votre_jeton" }
Invoke-RestMethod -Uri "https://votre-entreprise.evyooht.com/api/v1/receivings/310" -Headers $headers

javascript

const response = await fetch("https://votre-entreprise.evyooht.com/api/v1/receivings/310", {
  headers: { Authorization: "Bearer evy_at_votre_jeton" },
});
const data = await response.json();
console.log(data);

php

$ch = curl_init("https://votre-entreprise.evyooht.com/api/v1/receivings/310");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer evy_at_votre_jeton"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);

python

import requests

response = requests.get(
    "https://votre-entreprise.evyooht.com/api/v1/receivings/310",
    headers={"Authorization": "Bearer evy_at_votre_jeton"},
)
print(response.json())

Query parameters of the list#

All filters can be combined: they add up (AND). An unknown parameter or an invalid value is refused with a 400 error, never ignored.

Parameter	Type	Description
`page`	integer	Page number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper. Default: `1`.
`per_page`	integer	Results per page, from 1 to 100. Default: `25`.
`sort`	string	Sort fields, separated by commas, with `-` in front for descending order. Up to 3 fields. Sortable fields: `id`, `date`, `total`, `updated_at`. Default: `-date`. Default: `-date`.
`status`	string	open, hold, posted, void, or all. When omitted, drafts (status `hold`) are not listed. Allowed values: `open`, `hold`, `posted`, `void`, `all`.
`type`	string	receipt or return. Allowed values: `receipt`, `return`.
`vendor_id`	integer	Only records of this vendor.
`purchase_order_id`	integer	Only receivings linked to this purchase order.
`store_id`	integer	Only documents of this store.
`currency`	string	Only documents in this currency (USD or HTG).
`date_from`	string (date)	Only documents dated on or after this day (YYYY-MM-DD).
`date_to`	string (date)	Only documents dated on or before this day (YYYY-MM-DD), the whole day included.
`search`	string	Text contained in the receiving number, the vendor name or the vendor receipt number.
`updated_since`	string	Only records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).

Response fields#

The list and the detail route return these fields. A field is null when the value is not recorded. A field marked needs permission is absent (not empty) unless your client holds that permission.

Field	Type	Description
`id`	integer	Unique identifier. Use it in the detail route.
`number`	string\| null	Human-readable document number, for example I1-4149.
`type`	"receipt"\| "return" \| null	receipt (goods received) or return (goods returned to the vendor).
`store_id`	integer\| null	Identifier of the store that owns the document (see the stores resource).
`date`	string(date-time, local) \| null	Document date and time (store local time, no time zone).
`receipt_number`	string\| null	Number of the vendor delivery note or invoice.
`receipt_date`	string(date) \| null	Date of the vendor delivery note or invoice.
`purchase_order_id`	integer\| null	Identifier of the purchase order received, when there is one.
`vendor_id`	integer\| null	Identifier of the vendor (see the vendors resource).
`vendor_name`	string\| null	Company name of the vendor.
`status`	"open"\| "hold" \| "posted" \| "void" \| null	open, hold, posted or void.
`currency`	string\| null	Currency of the document: USD or HTG.
`exchange_rate`	number\| null	Exchange rate between USD and HTG recorded on the document.
`quantity_total`	number\| null	Total quantity of items on the document.
`items_total`	number\| null	Sum of the item amounts, before discount, tax and shipping. The document totals are the reference: lines carry facts, not computed line totals.
`discount_percent`	number\| null	Discount, as a percentage.
`discount_amount`	number\| null	Discount amount.
`tax`	number\| null	Tax amount.
`freight`	number\| null	Freight charges.
`fee`	number\| null	Other fees.
`total`	number\| null	Grand total of the document.
`notes`	string\| null	Free-text notes printed on the document.
`created_at`	string(date-time, local) \| null	When the record was created (local time, no time zone).
`updated_at`	string(date-time, local) \| null	When the record was last modified (local time, no time zone). Use it with the updated_since filter to synchronize.

Relation: lines#

Returned by the detail route only. The lines of the receiving.

Field	Type	Description
`id`	integer	Identifier of the line.
`product_id`	integer\| null	Identifier of the product.
`name`	string\| null	Item name.
`description`	string\| null	Item description.
`barcode`	string\| null	Barcode.
`quantity`	number\| null	Quantity received, in the unit shown in unit.
`unit`	string\| null	Unit of the line.
`unit_price`	number\| null	Purchase price of one unit.
`new_price`	number\| null	Selling price set at reception.
`base_quantity`	number\| null	Quantity expressed in the base unit of the product.
`average_cost` needs costs:read	number\| null	Average cost after reception. Requires costs:read.
`previous_cost` needs costs:read	number\| null	Cost before reception. Requires costs:read.
`previous_average_cost` needs costs:read	number\| null	Average cost before reception. Requires costs:read.

Example response: list#

json

{
  "data": [
    {
      "id": 310,
      "number": "R1-310",
      "type": "receipt",
      "store_id": 1,
      "date": "2026-03-15T14:30:00",
      "receipt_number": "DN-20931",
      "receipt_date": "2026-03-15",
      "purchase_order_id": 95,
      "vendor_id": 12,
      "vendor_name": "Papeterie Delmas",
      "status": "open",
      "currency": "USD",
      "exchange_rate": 130.5,
      "quantity_total": 12,
      "items_total": 1250,
      "discount_percent": 0,
      "discount_amount": 0,
      "tax": 0,
      "freight": 0,
      "fee": 0,
      "total": 1250,
      "notes": "Delivered on Friday.",
      "created_at": "2026-03-15T14:30:00",
      "updated_at": "2026-03-15T14:30:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

Example response: one record#

json

{
  "data": {
    "id": 310,
    "number": "R1-310",
    "type": "receipt",
    "store_id": 1,
    "date": "2026-03-15T14:30:00",
    "receipt_number": "DN-20931",
    "receipt_date": "2026-03-15",
    "purchase_order_id": 95,
    "vendor_id": 12,
    "vendor_name": "Papeterie Delmas",
    "status": "open",
    "currency": "USD",
    "exchange_rate": 130.5,
    "quantity_total": 12,
    "items_total": 1250,
    "discount_percent": 0,
    "discount_amount": 0,
    "tax": 0,
    "freight": 0,
    "fee": 0,
    "total": 1250,
    "notes": "Delivered on Friday.",
    "created_at": "2026-03-15T14:30:00",
    "updated_at": "2026-03-15T14:30:00",
    "lines": [
      {
        "id": 9001,
        "product_id": 463,
        "name": "Thermal paper roll 57x18m",
        "description": "Thermal paper roll for receipt printers",
        "barcode": "6291041500213",
        "quantity": 10,
        "unit": "Box of 100",
        "unit_price": 125,
        "new_price": 130,
        "base_quantity": 1000,
        "average_cost": 92.5,
        "previous_cost": 88,
        "previous_average_cost": 91
      }
    ]
  }
}

Errors#

The error format and the full list of codes are described in Errors.

Status	When
`400`	A query parameter is invalid or unknown. Every fault is reported at once in `error.details`. Nothing is ignored silently.
`401`	The token is missing, malformed, expired or revoked (`missing_token` or `invalid_token`). Ask for a new token.
`403`	Your token does not carry the permission this route needs (`insufficient_scope`), or the request was not made over HTTPS (`https_required`).
`429`	Too many requests this minute. Wait for the number of seconds in the `Retry-After` header.

Une erreur, une question, un point pas clair ? Écrivez-nous. Si vous écrivez à propos d'une erreur de l'API, joignez son request_id.