Registers

Overview Authentication Versions Requests Responses

Reference

Account Users Clients Balance Resume Covenants Delivery Discountcards Documents PaymentMethods Types Helpdesk Categories Integrations Kitchens Printer Products Brands Categories Lots Pricegroups Stocks Units Variants Receipts Registers Balance Movements Rooms Selfconsumption Stores Suppliers Tables Taxauthority Saft Taxes Exemptions

List GET

Example with mandatory parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/registers/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Example with all allowed parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/registers/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$method  = 'GET';
$params  = array(
    'store_id' => 1234, 
    'type'     => 'auto - Automático
pos - Normal (Venda Produtos/Serviços)
rest - Restaurante (Gestão de Salas/Mesas)
api - API (Integração Programática)
office - Office
rest_terminal - Terminal de Pedidos (Pedidos à Mesa/Cozinha)
 Multiple: pos,rest_terminal', 
    'isActive' => 'yes', 

);
$url .= '?' . http_build_query($params);
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
$result = curl_exec($curl);
?>

Request

Name	Type	Example	Description
store_id	int	1234	Store ID
type	string	`auto` - Automático `pos` - Normal (Venda Produtos/Serviços) `rest` - Restaurante (Gestão de Salas/Mesas) `api` - API (Integração Programática) `office` - Office `rest_terminal` - Terminal de Pedidos (Pedidos à Mesa/Cozinha) Multiple: pos,rest_terminal	Register Type
isActive	string yes		Active Registers

Response

Name	Type	Example	Description
id	int		Register ID
store_id	int	123	Store ID
title	string	POS 1	Title
products_show_reference	string yes, no		Show Reference
products_show_tax	string yes, no		Show Tax
document_type_id	string	FT	Document Type ID
expires	date	2025-12-20	Expiration date
status	string close, open		Status
situation	string on, on		Status
mode	string normal, tests		Register Mode
type	string	pos	Register Type
show_products	string all, without_barcode, none		Show Products
default_pay_due	string		Default Pay Due

Detail GET

Example with mandatory parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/registers/12345/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Example with all allowed parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/registers/12345/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Request

Response

Name Type Example Description

id int Register ID

store_id int 123 Store ID

title string POS 1 Title

expires date 2025-12-20 Expiration date

subscription_active

string

yes, no

type

string

auto, pos, rest, api, office, rest_terminal

finalize_advanced

string

yes, no

Whether to use advanced finalize

status

string

close, open

Status

situation

string

on, on

Status

mode

string

normal, tests

document_type_id string Default Document Type

prices_group int Register Price Group

products array Products options

Name	Type	Example	Description
show_reference	string yes, no		Whether reference should be visible
show_tax	string yes, no		Whether visible prices should include tax

show_tax

string

yes, no

Whether visible prices should include tax

default_tax_value

string

NOR - Taxa Normal
INT - Taxa Intermédia
RED - Taxa Reduzida
ISE - Isento
OUT - Outros

Default Tax Value

print array Printing options

Name

Type

Example

Description

duplicate

array

Products options

Name	Type	Example	Description
active	string yes, no		Status
copies	int	2	Number of copies

method

string

browser, vendusdesktop

Printing method

use_default_printer

int

0, 1

Whether to use default printer

printer_name

string

Epson TM-T20II

Printer name

paper_size

string

58, 72, 72B

Paper Size

escpos_type

string

v1, v2, v3

ESC/POS Type

print_popup

string

yes, no

Whether to print document or send it by email

show_products

string

all, without_barcode, none

Show Products

default_pay_due string 15,30,60,90 Registers default due date

API (v1.1)

List GET

Example with mandatory parameters

Example with all allowed parameters

Request

Response

Detail GET

Example with mandatory parameters

Example with all allowed parameters

Request

Response