Yurest WS Docs

Introduction

The Yurest WebService documentation is avalible now.

Get up and running quickly with our easily components that enable our clients to select and save all your contents from Yurest Platform.

The documents collection provides methods that you use to invoke the Yurest API.

URL

The webservice can be used both on Dev env. and Production env. The token is unique and It will only be valid for a client within an environment.

Dev Environment

https://cliente.dev.yurest.com/ws/{token}/{endpoint}

Production Environment

https://cliente.yurest.com/ws/{token}/{endpoint}

Parameter	Description
`token`	Token key necessary to access our WS.
`endpoint`	All endpoints avaliables, e.g., https://cliente.dev.yurest.com/api/{token}/products

Response

All responses come with state 200 on JSON format.

Parameter	Type	Description
`status`	Boolean	The calling result: 0 when has error or 1 when is OK.
`message`	String	Message with information about what happened on the call.
`data`	Array	All the retrieve data on Json format.

JSON response example

                    
                      { status:1, message:'Productos en data', data: [...]}

Produtcts

GET

Retrieve a list of products that belongs to client

/products?id_above=1

Parameter	Type	Optional	Default	Description
`id_above`	Integer	True	-	All ID’s above the ID sent.

POST

Save/Update a product based on parameters that are sent on the request.

/products

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	Product ID: If the ID is sent, those other parameters will be used to edit product information.
`id_tpv`	Integer	False	-	Product ID based on origin system.
`solo_parear`	Boolean	true	false	Just create the product as outer product to pair.
`nombre`	String	False	-	Product name
`id_iva`	Integer	True	3	The IVA aplied on the product can be: 1 for '4%', 2 for '10%', 3 for '21%' and 4 for '0'.
`id_unidad`	Integer	True	null	Base unit of measure. can be: 1 for 'Litro', 3 for 'Kilo', 5 for 'Unidades'
`compra`	Boolean	True	false	When the product can be purchased from a supplier.
`venta`	Boolean	True	false	When the product can be sell.

Order

GET

Retrieve a list of orders that belongs to a client

/order

Parameter	Type	Optional	Default	Description
`lines_details`	Boolean	True	false	FALSE If you don’t want to show all those lines from the order. TRUE If want’s show all from the order.
`id_above`	Integer	True	0	All ID’s above the ID sent.
`limit`	Integer	True	10	limit of items returned.

Order Detail

GET

Retrieve a single order by its ID.

/{token}/purchases/orders/{id}

Parameter	Type	Optional	Default	Description
`id`	Integer	False	-	Order ID.

Delivery note

GET

Retrieve a list of delivery notes that belongs to a client

/delivery_note

Parameter	Type	Optional	Default	Description
`lines_details`	Boolean	True	false	FALSE If you don’t want to show all those lines from the delivery note. TRUE If want’s show all.
`id_above`	Integer	True	0	All ID’s above the ID sent.
`limit`	Integer	True	10	limit of items returned.
`date_from`	Date	True	null	Creation date lower range (YYYY-MM-DD)
`date_to`	Date	True	null	Creation date upper range (YYYY-MM-DD)
`updated_date_from`	Date	True	null	Update date lower range (YYYY-MM-DD)
`updated_date_to`	Date	True	null	Update date upper range (YYYY-MM-DD)

Parameter	Type	Optional	Default	Description
`id`	Integer	False	-	Delivery note ID.

Bills

GET

Retrieve a list of bills that belongs to a client

/bill

Parameter	Type	Optional	Default	Description
`lines_details`	Boolean	True	false	FALSE If you don’t want to show all those lines from the bill. TRUE If want’s show all.
`id_above`	Integer	True	0	All ID’s above the ID sent.
`id_local`	Integer	True	0	Filter bills by store.
`from_date`	Date	True	null	Date formatted like ‘2018-06-20’.
`to_date`	Date	True	null	Date formatted like ‘2018-06-20’.
`limit`	Integer	True	10	limit of items returned.
`deleted`	Integer	True	0	0 for not including deleted invoice lines; 1 for including them.

Unities

GET

Retrieve a list of unities

/unities

Family buys

GET

Retrieve a list of family buys

/family_buys

Providers

GET

Retrieve a list of providers

/providers

POST

Save/Update a provider based on parameters that are send on the request.

/providers

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	Provider ID: If the ID is sent, those other parameters will be using to edit information.
`id_externo`	String	False	-	Provider ID based on origin system.
`nombre`	String	False	-	Provider name
`denominacion`	String	True	-	Provider legal name
`cif`	String	True	-	Provider CIF/NIF

Providers Products

GET

Retrieve a list of products that belong to a provider

/provider_products?id_proveedor=x

Parameter	Type	Optional	Default	Description
`id_proveedor`	Integer	True	-	Provider ID to filter content.
`limit`	Integer	True	-	Set a limit of rows.

POST

Create/Update a provider products based on parameters that are send on the request.

/provider_products

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	Product Provider ID: If the ID is sent, those other parameters will be using to edit information.
`id_producto`	Integer	False	-
`id_proveedor`	Integer	False	-
`referencia`	String	True	-
`cantidad`	Float	True	1	Quantity in the supplier product in the unit of the primary product. Example: If the primary product is apples and they are in kg, the supplier sells in 5kg bags. this field should be put cantidad = 5 and format_compra = bags
`formato_compra`	String	True	-	The format in which the supplier sells the product. Example: Bolsa, Saco, Bandeja...
`cantidad_multiplo`	Integer	True	-	If the product is sold in a pack, how many come per pack. For example, Coca-Cola comes in boxes of 24 units.
`multiplo_label`	String	True	Pack	If the product comes in multiples, the name of this grouping. Example Box
`precio`	Float	True	0
`descuento`	Float	True	0	Discount in %.

DELETE

Drop a provider products based on the ID send on the request.

/provider_products/ID?

Favorite Providers Products

GET

Retrieve a list of favorite products that belong to a provider

/favorite_provider_products?id_proveedor=x&id_local=x

Parameter	Type	Optional	Default	Description
`id_proveedor`	Integer	True	-	Provider ID to filter content.
`id_local`	Integer	True	-	Store ID to filter content.
`limit`	Integer	True	-	Set a limit of rows.

POST

Create/Update a favorite provider products based on parameters that are send on the request.

/favorite_provider_products

Parameter	Type	Optional	Default	Description
`id`	Integer	False	-	Product Provider ID. This ID already identifies the product and the provider
`id_local`	Integer	False	-	Store ID
`favorito`	Boolean	True	True

Storage locations

GET

Retrieve the storage locations that belong to a client.

/storage_location

Parameter	Type	Optional	Default	Description
`limit`	Integer	True	100	Set a limit of rows.

Stock Details

GET

Retrieve the storage that belong to a client.

/stock_details?date_from=2021-05-30&date_to=2021-06-30

Parameter	Type	Optional	Default	Description
`date_from`	Date	False	-	Date formatted like ‘2018-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2018-06-20’.
`id_product`	Integer	True	-	Product ID: If the ID is sent, those other parameters will be used to edit the information.
`id_store`	Integer	true	-	Store Id.
`id_location`	Integer	True	-	Location Id corresponding with the storage's location.
`id_above`	Integer	True	-	All ID’s above the ID sent.
`movement_type`	String	True	-	The type of movement to be filtered, among the following: "wastage" (mermas) "inventory" (inventarios) "purchase" (compras) "sale" (ventas) "production" (producciones) "transfer" (traslados) If you desire to filter by multiple types, you can do so by separating them with commas, for example: "wastage, inventory, purchase".
`limit`	Integer	True	100	Set a limit of rows.

Stock

GET

Retrieve the stock of products that belong to a client.

/stock

Parameter	Type	Optional	Default	Description
`id_location`	Integer	True	-	Location Id corresponding with the storage's location.

Cash Flow In

GET

Retrieve a list of cash flow in that belongs to a client

/cashflowin

Parameter	Type	Optional	Default	Description
`id_above`	Integer	True	0	All ID’s above the ID sent.
`limit`	Integer	True	100	limit of items returned.

POST

Save/Update a cash flow in based on parameters that are sent on the request.

/cashflowin

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	Product ID: If the ID is sent, those other parameters will be used to edit cash flow in information.
`id_store`	Integer	False	-	Store Id.
`id_user`	Integer	False	-	User ID.
`id_turn`	Integer	False	-	You can pass three different Ids: 1 for morning turn, 2 for evening turn and 3 for night turn.
`efectivo`	Float	True	-	Money amount.
`transferencia`	Float	True	-	Money amount transferred.
`importe`	Float	False	-	Total amount.
`comensales`	Integer	True	-	Number of clients.
`cocina`	Integer	True	-	Number of employees in the kitchen.
`sala`	Integer	True	-	Number of employees in the dining room.
`comentarios`	String	True	-	Comments about the service.
`fecha`	Date	False	-	Day when was did the cash flow in.

Sales

GET

Retrieve all sales receipt from others origin systems.

/sales

Parameter	Type	Optional	Default	Description
`limit`	Integer	True	100	Set a limit of rows.
`id_above`	Integer	True	-	All ID’s above the ID sent.
`store_id`	Integer	True	-	Store ID.
`deleted`	Integer	True	0	0 for getting only non-deleted records. 1 for including deleted records.

POST

Save/Update sales from others origin systems.

/sales

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	Ticket ID: If the ID is sent, those other parameters will be used to edit ticket id information.
`id_local`	Integer	True	-	Store ID.
`id_ticket_tpv`	Integer	False	-	Ticket external ID from TPV.
`id_ticket_tpv_asociado`	Integer	True	-
`comensales`	Integer	True	-	Customers quantity.
`descuento`	Float	True	-	Discount rate. No discount applies in the amount fields, we only save the data as additional information.
`iva_importe`	Float	True	-	Only the amount of VAT
`base_importe`	Float	True	-	Amount without VAT included
`importe`	Float	True	-	Total amount with VAT included.
`fecha_apertura`	DateTime	False	-	Date and time when's open the order.
`fecha_cierre`	DateTime	True	-	Date and time when the order is closed.

DELETE

Remove a sales receipt from the system, including its lines and warehouse moves.

/sales/{id}

Parameter	Type	Optional	Default	Description
`id`	Integer	True	False	The ID of the ticket to delete.

Sales lines

GET

Retrieve the details of a sales receipt

/sales_lines

Parameter	Type	Optional	Default	Description
`limit`	Integer	True	-1	Set a limit of rows.
`id_above`	Integer	True	-	All ID’s above the ID sent.
`store_id`	Integer	True	-	Store ID.

POST

Save/Update sales lines from others origin systems.

/sales_lines

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	Ticket Line ID: If the ID is sent, those other parameters will be used to edit ticket line id information.
`id_tpv_terminal`	Integer	True	Null	Point-of-sale (POS) terminal ID.
`id_producto_tpv`	Integer	False	-	Product ID.
`id_local_tpv`	Integer	True	-	Store ID.
`id_ticket_tpv`	Integer	True	-	External ID from TPV.
`menu`	boolean	True	False	indicates if the line belongs to a menu
`combinado`	boolean	True	False	indicates if the line belongs to a combination
`formato_label`	String	True	-	Sales format, e.g., if you buy a bottle, to sell it in drinks shots.
`formato_cantidad`	Float	True	-	Quantity that corresponds to the sales format.
`cantidad`	Float	True	-	Product quantity.
`precio`	Float	True	-	Product price.
`fecha_hora`	DateTime	Fale	-	Date formatted like timestamp 2018-06-20 10:22:00.
`observaciones`	Integer	True	-	Observaciones.

DELETE

Remove a sales receipt line from the system, including its warehouse moves.

/sales_lines/{id}

Parameter	Type	Optional	Default	Description
`id`	Integer	True	False	The ID of the ticket line to delete.

Family expenses

GET

Retrieve a list of family expenses

/family_expenses

General Expenses

GET

Retrieve a list of general expenses that belongs to a client

/general_expenses?date_from=2020-06-01&date_to=2020-06-30

Parameter	Type	Optional	Default	Description
`date_from`	Date	False	-	Date formatted like ‘2020-06-01’.
`date_to`	Date	False	-	Date formatted like ‘2020-06-30’.

Personal Expenses

GET

Retrieve a list of personal expenses that belongs to a client

/personal_expenses?date_from=2020-06-01&date_to=2020-06-30

Parameter	Type	Optional	Default	Description
`date_from`	Date	False	-	Date formatted like ‘2020-06-01’.
`date_to`	Date	False	-	Date formatted like ‘2020-06-30’.

Checklists

GET

Retrieve a list of checklists that belongs to client

/checklists?date_from=2021-06-20&date_to=2021-06-30

Parameter	Type	Optional	Default	Description
`limit`	Integer	True	50	Set a limit of rows.
`id_store`	Integer	True	-	Store ID
`id_above`	Integer	True	-	All ID’s above the ID sent.
`date_from`	Date	False	-	Date formatted like ‘2018-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2018-06-20’.
`item_details`	Boolean	True	false	FALSE If you don’t want to show all those items from the list of checklists. TRUE If you want to show all from the checklist.

Audits

GET

Retrieve a list of audits that belongs to client

/audits?date_from=2021-06-20&date_to=2021-06-30

Parameter	Type	Optional	Default	Description
`limit`	Integer	True	50	Set a limit of rows.
`id_store`	Integer	True	-	Store ID
`id_above`	Integer	True	-	All ID’s above the ID sent.
`date_from`	Date	False	-	Date formatted like ‘2018-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2018-06-20’.
`item_details`	Boolean	True	false	FALSE If you don’t want to show all those items from the list of audits. TRUE If you want to show all.

Apccs

GET

Retrieve a list of apccs that belongs to a client

/apccs?date_from=2021-06-20&date_to=2021-06-30

Parameter	Type	Optional	Default	Description
`limit`	Integer	True	50	Set a limit of rows.
`id_store`	Integer	True	-	Store ID
`id_above`	Integer	True	-	All ID’s above the ID sent.
`date_from`	Date	False	-	Date formatted like ‘2018-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2018-06-20’.
`item_details`	Boolean	True	false	FALSE If you don’t want to show all those items from the list of apccs. TRUE If you want to show all.

Restauration Services

GET

Retrieves a list of Restauration Services

/restauration_services

Absences

GET

Retrieves a list of absences for a client

/absences?date_from=2022-01-01&date_to=2022-01-31

Parameter	Type	Optional	Default	Description
`date_from`	Date	False	-	Date formatted like ‘2022-01-01’.
`date_to`	Date	False	-	Date formatted like ‘2022-01-31’.
`user_id`	Integer	True	-	User ID.
`deleted`	Integer	True	-	TRUE if you want to include on the list those absences that were deleted, FALSE otherwise
`limit`	Integer	True		limit of items returned.

Planning Services

GET

Retrieves a list of plannings for a client

/planning?date_from=2020-06-30&date_to=2021-06-30&published=1

Parameter	Type	Optional	Default	Description
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.
`published`	String	False	-	TRUE if you want to get the list of services that are published, FALSE otherwise
`limit`	Integer	True	-	limit of items returned.

Contracts

GET - Single Contracts

Retrieve detailed information about a specific contract.

/{token}/contracts/{id}

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Your API token
`id`	Integer	False	-	ID of the contract to retrieve.

GET - Multiple Contracts

Retrieve a list of Contracts that belong to a client

/{token}/contracts

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Your API token
`localId`	Integer	True	-	ID of the location to filter contracts by.
`employeeId`	Integer	True	-	ID of the employee to filter contracts by.

Signings

GET

Retrieves a list of signings for a client

/signings?date_from=2020-06-30&date_to=2021-06-30

Parameter	Type	Optional	Default	Description
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.
`limit`	Integer	True		limit of items returned.

Shift Scheduler

GET

Retrieve available settings and configuration for scheduled shift creation, including stores, departments (and its areas) and food services.

/hr/shifts/scheduler/parameters

Parameter	Type	Optional	Default	Description
`store_id`	Integer	True	-	ID of a specific store for loading its valid parameters.

POST

Create an employee scheduled shift assignment.

/hr/shifts/scheduler

Parameter	Type	Optional	Default	Description
`from_datetime`	String	False	-	Start datetime of the scheduled shift, in `YYYY-MM-DD HH:MM:SS` format.
`to_datetime`	String	False	-	End datetime of the scheduled shift, in `YYYY-MM-DD HH:MM:SS` format.
`employee_id`	Integer	False	-	ID of the employee to assign.
`store_id`	Integer	False	-	ID of the store where the shift will take place.
`department_id`	Integer	False	-	ID of the department where the shift will take place.
`department_area_id`	Integer	False	-	ID of the department area where the shift will take place.
`food_service_id`	Integer	False	-	ID of the shift-associated food service.
`publish`	Boolean	True	False	Whether to publish the scheduled shift assignment or not.

Resumen EBITDA

GET/POST

Retrieve a report EBITDA

/ebita?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.

Resumen EBITDA - Delivery Notes

GET/POST

Retrieve a report EBITDA - Delivery Notes

/ebita_delivery_notes?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.

Resumen EBITDA - General Expenses

GET/POST

Retrieve a report EBITDA - General Expenses

/ebita_general_expenses?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.

Resumen EBITDA - Personal Expenses

GET/POST

Retrieve a report EBITDA - Personal Expenses

/ebita_personal_expenses?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.

Resumen EBITDA - Sales

GET/POST

Retrieve a report EBITDA - Sales

/ebita_sells?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.

EBITDA Details - Delivery Notes

GET/POST

Retrieve a report EBITDA Details - Delivery Notes

/ebita_delivery_notes_details?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-20’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-20’.

EBITDA Details - General Expenses

GET/POST

Retrieve a report EBITDA Details - General Expenses

/ebita_general_expenses_details?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-30’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-30’.

EBITDA Details - Personal Expenses

GET/POST

Retrieve a report EBITDA Details - Personal Expenses

/ebita_personal_expenses_details?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-30’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-30’.

EBITDA Details - Sales

GET

Retrieve a report EBITDA Details - Sales

/ebita_sells_details?date_from=2020-06-30&date_to=2021-06-30&store_id=33

Parameter	Type	Optional	Default	Description
`store_id`	Integer	False	-	Store ID
`date_from`	Date	False	-	Date formatted like ‘2021-06-30’.
`date_to`	Date	False	-	Date formatted like ‘2021-06-30’.

Stores

GET

Retrieve a list of stores that belong to a client

/stores

Parameter	Type	Optional	Default	Description
`id_above`	Integer	True	-	All ID’s above the ID sent.

POST

Save/Update a store based on parameters that are sent on the request.

/stores

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	Store ID: If the ID is sent, those other parameters will be used to edit store information.
`nombre`	String	False	-	Store name.
`descripcion`	String	False	-	Store description
`telefono`	String	False	-	Store phone number.
`web`	String	False	-	Web address.
`email`	String	False	-	Email
`direccion`	String	False	-	Store Address
`cp`	String	False	-	Store address postal code
`municipio`	String	False	-	Store address city
`provincia`	String	False	-	Store address province
`direccion_fac`	String	True	-	Billing address
`cp_fac`	String	True	-	Billing Address postal code
`municipio_fac`	String	True	-	Billing address city
`provincia_fac`	String	True	-	Billing address province
`activo`	Boolean	True	True	0 If it’s unavailable, 1 If it’s available

Users

GET

Retrieve a list of users that belong to a client

/users

Parameter	Type	Optional	Default	Description
`limit`	Integer	True	50	Set a limit of rows.

POST

Save/Update a user based on parameters that are sent on the request.

/users

Parameter	Type	Optional	Default	Description
`id`	Integer	True	-	User ID: If the ID is sent, those other parameters will be used to edit user information.
`id_externo`	Integer	False	-	Id from your system that will be related with our system.
`name`	String	False	-	Name.
`last_name`	String	False	-	Last name.
`email`	String	False	-	E-mail.
`dni`	String	True	-	DNI.
`phone`	String	True	-	Telephone.
`password`	String	True	-	Password.

Roles

GET - Single Role

Retrieve detailed information about a specific role.

/{token}/roles/{id}

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Your API token
`id`	Integer	False	-	ID of the role to retrieve.

GET - Multiple roles

Retrieve a list of roles that belong to a client

/{token}/roles

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Your API token

Recipes

GET - Single Recipe

Retrieve detailed information about a specific recipe

/recipes/{recipeId}

Parameter	Type	Optional	Default	Description
`recipeId`	Integer	False	-	ID of the recipe to retrieve.
`withIngredients`	Boolean (0, 1)	True	True	Set to `1` to include the recipe ingredients, `0` to exclude them.
`with_results`	Boolean (0, 1)	True	True	Set to `1` to include the recipe results, `0` to exclude them.

GET - Multiple Recipes

Retrieve a list of recipes based on query parameters

/recipes?store_id=1&recipe_family_id=1

Parameter	Type	Optional	Default	Description
`store_id`	Integer	True	-	For filtering by store.
`recipe_family_id`	Integer	True	-	For filtering by recipe family.
`with_results`	Boolean (0, 1)	True	True	Set to `1` to include the recipe results, `0` to exclude them.

Menus

GET - Single menu

Retrieve detailed information about a specific menu

/menus/{menuId}

Parameter	Type	Optional	Default	Description
`menuId`	Integer	False	-	ID of the menu to retrieve.

GET - Multiple Menus

Retrieve a list of menus based on query parameters

/menus

Parameter	Type	Optional	Default	Description
`name`	String	True	-	Filter by menu name, with partial match.
`description`	String	True	-	Filter by menu description, with partial match.
`active`	Integer (0, 1)	True	-	Filter by active/inactive status (0 = inactive, 1 = active).
`deleted`	Integer (0, 1)	True	-	Filter by deletion status (0 = not deleted, 1 = deleted).

Productions

GET - Recipe Production Detail

Retrieve detailed information about a specific production of a recipe.

/recipes/productions/{productionId}

Parameter	Type	Optional	Default	Description
`productionId`	Integer	False	-	ID of the recipe production to retrieve.

GET - Elaboration Production Detail

Retrieve detailed information about a specific production of an elaboration.

/elaborations/productions/{productionId}

Parameter	Type	Optional	Default	Description
`productionId`	Integer	False	-	ID of the elaboration production to retrieve.

Kitchen scheduler

POST - Create an scheduled production

Create a new scheduled production

/kitchen/production-scheduler/events

Parameter	Type	Optional	Default	Description
`from_datetime`	String	False	-	Start date and time for the scheduled production, in `YYYY-MM-DD HH:MM:SS` format.
`to_datetime`	String	False	-	End date and time for the scheduled production, in `YYYY-MM-DD HH:MM:SS` format. If the production has an explicit duration, this parameter will be ignored.
`recipe_id`	Integer	*	null	ID of the recipe to use for the scheduled production. If provided, `elaboration_id` will be ignored.
`elaboration_id`	Integer	*	null	ID of the elaboration to use for the scheduled production. If `recipe_id` is provided, will be ignored.
`quantity`	Float	False	-	Quantity to be produced.
`store_id`	Integer	True	null	ID of the store to use for the scheduled production. When null, it will schedule the production for every store.
`description`	String	True	null	Optional notes for the scheduled production.
`priority`	Integer	True	0	A numeric value representing the priority of the scheduled production.
`assigned_users`	Array of Integers	True	[]	List of user IDs assigned to the scheduled production.

Product Data Sheets

GET - Single Product Data Sheet

Retrieve detailed information about a product data sheet by ID

/product-data-sheets/{id}

Parameter	Type	Optional	Default	Description
`id`	Integer	False	-	ID of the product data sheet.

GET - Multiple Product Data Sheets

Retrieve a list of product data sheets with optional filters

/product-data-sheets?master_family_id=1&store_id=1

Parameter	Type	Optional	Default	Description
`master_family_id`	Integer	True	-	Filter by master family ID.
`selling_family_id`	Integer	True	-	Filter by selling family ID.
`item_id`	Integer	True	-	Filter by item ID.
`store_id`	Integer	True	-	Filter by store ID.
`is_active`	Boolean (0, 1)	True	-	Filter by active status.

Inventories

GET - Single Inventory

Retrieve a specific inventory by its ID

/stores/warehouse-locations/inventories/{inventoryId}

Parameter	Type	Optional	Default	Description
`inventoryId`	Integer	False	-	ID of the inventory to retrieve.

GET - Multiple Inventories

Retrieve a list of inventories matching filters

/stores/warehouse-locations/inventories?store_id=1&date_from=2024-01-01&date_to=2024-12-31

Parameter	Type	Optional	Default	Description
`store_id`	Integer	True	-	ID of the store.
`location_id`	Integer	True	-	ID of the warehouse location.
`date_from`	Date	True	-	Start date for the inventory data (YYYY-MM-DD).
`date_to`	Date	True	-	End date for the inventory data (YYYY-MM-DD).

Events

GET - Single event

Retrieve a specific event by its external ID

/event/find

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token
`externalEventId`	String	False	-	External ID assigned to single event

Post - Create New Event

Create a new event in the system, assigning an external ID and initial properties.

/event/new

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token for authentication.
`title`	String	False	-	Name/title of the new event (max 255 chars).
`startDate`	Date/Time	False	-	Event start date and time (e.g., YYYY-MM-DD HH:MM:SS).
`endDate`	Date/Time	False	-	Event end date and time. Must be after or equal to `startDate`.
`people`	Integer	False	-	Estimated number of attendees/guests (min 1).
`stores`	Array of Integer	False	-	List of Store IDs where the event will take place (min 1 ID, must exist in the `locales` table).
`description`	String	True	null	Public description of the event.
`internalDescription`	String	True	null	Internal notes or description for staff.
`externalId`	String	True	null	Unique external identifier for the event (max 255 chars).
`familyId`	Integer	True	null	ID of the associated event family (max 255).

Put - Update Existing Event

Update properties of an existing event using its internal ID.

/event/update

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token for authentication.
`eventId`	Integer	False	-	Internal ID of the event to be updated (must exist in the `events` table).
`title`	String	True	null	New name/title of the event (max 255 chars).
`startDate`	Date/Time	True	null	New event start date and time (e.g., YYYY-MM-DD HH:MM:SS).
`endDate`	Date/Time	True	null	New event end date and time. Must be after or equal to `startDate`.
`people`	Integer	True	null	New estimated number of attendees/guests (min 1).
`stores`	Array of Integer	True	null	New list of Store IDs where the event will take place (min 1 ID, must exist in the `locales` table).
`description`	String	True	null	New public description of the event.
`internalDescription`	String	True	null	New internal notes or description for staff.
`externalId`	String	True	null	New unique external identifier for the event (max 255 chars).
`familyId`	Integer	True	null	New ID of the associated event family (max 255).

Event's menus

Post - Add new menu

Insert a menu and subitems into the event

/event/menu/new

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token
`externalEventId`	Integer	False	-	External ID assigned to single event
`menuName`	String	False	-	Name for the menu
`description`	String	False	-	Description for the menu
`quantity`	Float	False	-	Estimated quantity of menus for the event
`price`	Float	False	-	Price to assigne per menu
`numPeople`	Integer	False	-	Number of people the menu is prepared for
`sections`	Array MenuSection	False	-	Content of the menu

Post - Edit menu

Modify a specific menu and subitems from the event

/event/menu/update

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token
`menuId`	Integer	False	-	Menu configuration ID
`menuName`	String	False	-	Name for the menu
`description`	String	False	-	Description for the menu
`quantity`	Float	False	-	Estimated quantity of menus for the event
`price`	Float	False	-	Price to assigne per menu
`numPeople`	Integer	False	-	Number of people the menu is prepared for
`sections`	Array MenuSection	False	-	Content of the menu
`delete`	Boolean	True	True	When delete option is enable, menu sections which ID is not mentioned on request, will be deleted

Post - Remove menu

Delete a specific menu from the event

/event/menu/delete

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token
`menuId`	String	False	-	Menu configuration ID

Event's products

Post - Add new product configuration

Insert a specific product configuration into the event

/event/product/new

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token
`externalEventId`	String	False	-	External ID assigned to single event
`productId`	Integer	False	-	Yurest product ID
`type`	String	False	-	Product's family master type. Options : DRINK => 1, FOOD => 2
`quantity`	Float	False	-	Estimated quantity for product for event
`price`	Float	False	-	Price to assigne per unit

Post - Edit product configuration

Modify a specific product configuration from the event

/event/product/update

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token
`productConfigurationId`	String	False	-	Product configuration ID
`quantity`	Float	False	-	Estimated quantity for product for event
`price`	Float	False	-	Price to assigne per unit

Post - Remove product configuration

Delete a specific product configuration from the event

/event/product/delete

Parameter	Type	Optional	Default	Description
`token`	String	False	-	Provided API token
`productConfigurationId`	String	False	-	Product configuration ID

Getting started

Buys endpoints

Storage endpoints

Sales endpoints

Financial endpoints

Tasks endpoints

Human Resources endpoints

Reports endpoints

System endpoints

Kitchen endpoints

Product Data Sheet endpoints

Inventory endpoints

Events endpoints

Getting started

Introduction

URL

Dev Environment

Production Environment

Response

JSON response example

Buys endpoints

Produtcts

GET

POST

Order

GET

Order Detail

GET

Delivery note

GET

Delivery notes Detail

GET

Bills

GET

Unities

GET

Family buys

GET

Providers

GET

POST

Providers Products

GET

POST

DELETE

Favorite Providers Products

GET

POST

Storage endpoints

Storage locations

GET

Stock Details

GET

Stock

GET

Sales endpoints

Cash Flow In

GET

POST

Sales

GET

POST

DELETE

Sales lines

GET

POST

DELETE

Financial endpoints

Family expenses

GET

General Expenses

GET

Personal Expenses

GET

Tasks endpoints

Checklists

GET

Audits

GET

Apccs