Manual de Integração ZSAPI Versão: 1.8 Draft 2 Março, 2017

Manual de Integração ZSAPI

Versão: 1.8 Draft 2

Março, 2017

ZoneSoft - 2016 www.zonesoft.pt

ZSAPI 1 / 144

http://www.zonesoft.pt/

Alterações Introdução Nota Legal Termos usados neste documento

Nomenclaturas Pedidos | Requests Respostas

Respostas - Listagens Acesso

Interfaces ZSAPI Interface::Auth

Ação::authenticate Ação::logout

Interface::SalesSessions Ação::getSaleSession Ação::closeSaleSession Ação::getSalesDay Ação::saveSalesDaysInstances Ação::getOpenSaleSession Ação::saveSaleSession

Interface::Documents Ação::getInstance Ação::getInstances Ação::getDocumentsHeaders Ação::saveInstances Ação::setDocumentNull - deprecated na versão 1.5. Substituída por setInstanceAsNulled Ação::setInstanceAsNulled Ação::getSale - deprecated na versão 1.5. Substituída por getSaleInstance Ação::getSaleInstance Ação::getSalesFromDocument - deprecated na versão 1.5. Substituída por getSaleInstancesFromDocument Ação::getSaleInstancesFromDocument Ação::getPaymentDocsFromDocument - deprecated na versão 1.5. Substituída por getPaymentDocInstancesFromDocument Ação::getPaymentDocInstancesFromDocument Ação::getCounterBalancesFromDocument - deprecated na versão 1.5. Substituída por getCounterBalancesInstancesFromDocument Ação::getCounterBalancesInstancesFromDocument


ZSAPI 2 / 144


Ação::saveATCode Ação::getNumberDS - deprecated na versão 1.5. Substituída por getNumberDSInstances Ação::getNumberDSInstances Ação::saveNumberDS - deprecated na versão 1.5. Substituída por saveNumberDSInstances Ação::saveNumberDSInstances Ação::saveATInstance - deprecated na versão 1.5. Substituída por saveATTransportInstance Ação::saveATTransportInstance

Interface::Products Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::getInstancesToDelete

Interface::ExemptionReasons Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::getInstancesToDelete

Interface::Stores Ação::getInstance Ação::getInstances Ação::saveInstances Ação::getInstanceWithSettings

Interface::Units Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::getInstancesToDelete

Interface::Families Ação::getInstance


ZSAPI 3 / 144


Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::getSubFamily - deprecated na versão 1.5. Substituída por getSubFamilyInstance Ação::getSubFamilyInstance Ação::getSubFamiliesFromFamily - deprecated na versão 1.5. Substituída por getSubFamiliesInstancesFromFamily Ação::getSubFamiliesInstancesFromFamily Ação::saveSubFamilies - deprecated na versão 1.5. Substituída por saveSubFamiliesInstances Ação::saveSubFamiliesInstances Ação::deleteSubFamilies - deprecated na versão 1.5. Substituída por deleteSubFamiliesInstances Ação::deleteSubFamiliesInstances Ação::getSubFamiliesToSync - deprecated na versão 1.5. Substituída por getSubFamiliesInstancesToSync Ação::getSubFamiliesInstancesToSync Ação::setSubFamiliesFullSync Ação::getInstancesToDelete Ação::getSubFamiliesToDelete - deprecated na versão 1.5. Substituída por getSubFamiliesInstancesToDelete Ação::getSubFamiliesInstancesToDelete

Interface::PaymentTypes Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::getInstancesToDelete

Interface::Taxes Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::deactivateTaxes - deprecated na versão 1.5. Substituída por


ZSAPI 4 / 144


setInstancesAsInactive Ação::setInstancesAsInactive Ação::getActiveTaxes - deprecated na versão 1.5. Substituída por getActiveInstances Ação::getActiveInstances Ação::getInstancesToDelete

Interface::Clients Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::deactivateClients - deprecated na versão 1.5. Substituída por setInstancesAsInactive Ação::setInstancesAsInactive Ação::getInstancesToDelete

Interface::Operators Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::getActiveOperators - deprecated na versão 1.5. Substituída por getActiveInstances Ação::getActiveInstances Ação::getInactiveOperators - deprecated na versão 1.5. Substituída por getInactiveInstances Ação::getInactiveInstances

Interface::SalesStations Ação::getInstance Ação::getInstanceWithSettings Ação::getInstances Ação::getInstancesWithSettings Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::getInstancesToDelete

Interface::ProductStocks Ação::getCurrentStockInstances


ZSAPI 5 / 144


Ação::getStockInstanceByDate Ação::getCurrentStockInStores

Interface::Suppliers Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::getInstancesToDelete

Interface::Characteristics Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::getInstancesToDelete

Interface::Couverts Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::getInstancesToDelete

Interface::Technicalcards Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::getInstancesToDelete

Interface::ReasonBreaks Ação::getInstance Ação::getInstances Ação::saveInstances Ação::deleteInstances Ação::getInstancesToSync Ação::setFullSync Ação::getInstancesToDelete


ZSAPI 6 / 144


Alterações Este histórico de alterações tem como referência a versão Draft1 da Documentação Manual de Integração da ZSAPI.

Data Interface Descrição

2013-08-02 - - - v1.0

2013-08-28 Todas - Implementadas várias novas ações em praticamente todas as Interfaces da API; - Implementadas novas Interfaces da API; - Alterado nome de algumas das ações previamente existentes, implementando a convenção interna para padronizar o nome das ações das interfaces. - Alterações nas estruturas de entidades. - Adicionada à documentação a tabela de Convenções para alguns tipos de dados utilizados nos Requests.

2013-08-18 Todas v1.3 - Estruturas das Entidades foram atualizadas para a versão 1.3; - Nova Interface SalesStations; - Nas Interfaces foi adicionada nova ação getInstancesToDelete: para obter as instancias das respetivas Entidades Modelo, assinaladas para serem removidas: deve confirmar as Interfaces abrangidas; - Nova propriedade _errors nas instancias com erros: ver secção Respostas status: ZSAPI_UNPROCESSABLE_ENTITY;

2014-05-12 Productstocks Corrigida a estrutura de pedidos na ação getStockInstanceByDate

2014-07-03 Suppliers - Nova Interface Suppliers

2014-07-28 Characteristics - Nova Interface Characteristics

2014-10-01 Documents Adicionada funcionalidade para permitir a integração de


ZSAPI 7 / 144


documentos originados em outras softwares certicados pela AT.

2014-12-11 Endereço do serviço Novo endereço: api.zonesoft.org Endereço anterior: api.zsrestweb.com será mantido até novembro de 2015

2015-04-01 - Couverts, Technicalcards, Tablemovements. - Clients, Documents, Families, Operators, Taxes.

v1.5 - Nova Interface Technicalcards - Nova Interface Couverts. - Nova Interface Tablemovements. Ações marcadas como deprecated nas Interfaces: - Clients - Documents - Families - Operators - Taxes devem ser substiuídas pelas novas ações.

2016-11-01 -SalesDay -Stores

v1.6 - SalesDay , passa a poder receber argumentos. - Stores , getinstances BUGFIX

2017-01-01 - ReasonBreak (motivos de quebra) - Tablemovements

v1.7 - Nova Interface ReasonBreak - Nova Ação Tablemovements/ getTableDetails

2017-06-01 - Categories - ReasonBreak (motivos de quebra)

v1.8 - Nova Interface Categories - Nova Interface ReasonBreak


ZSAPI 8 / 144


Introdução O presente documento visa descrever os procedimentos e requisitos necessários à utilização da API da ZoneSoft - ZSAPI. Este documento destina-se aos nosso clientes que pretendam desenvolver soluções que possibilitem integrar outros serviços com os nossos serviços utilizando as diversas operações disponibilizadas pela nossa API.

Nota Legal


ZSAPI 9 / 144


Termos usados neste documento Request - O pedido http propriamente dito. Usado neste documento como uma entidade (objecto). Pedido - Ver Request. URL - O endereço URL usado no Request - e que faz parte do Request. Response - A resposta ao pedido http devolvida pela API. Usado neste documento como uma entidade (objecto). Resposta - Ver Response. StatusCode - Elemento de Response, usado para facultar ao cliente o número com o código do estado do Request. StatusMessage - Elemento de Response, usado para facultar ao cliente uma mensagem de texto com a mensagem sobre o código do estado do Request.

Content - Elemento de Response, usado para facultar ao cliente a informação solicitada no Request. POST - Um pedido http usando o método POST do protocolo http. GET - Um pedido http usando o método GET do protocolo http.Elemento Raíz (ER) - Um elemento presente no Request que não depende de nenhum outro hierarquicamente. Supondo o Request JSON:

{ "auth_hash":"be444cb8deef1db416f8dfc5350f5c12ae92761", "document":{"id":0} }

Os elementos auth_hash e document são exemplos de Elemento Raíz do Request; id não é Elemento Raiz.


ZSAPI 10 / 144


Nomenclaturas delete - Se for um método que dá uma ordem para apagar algo, deve sempre conter no inicio do nome delete. Ex: deleteInstances. save - Se for um método que escreve informação na base dados WEB, deve sempre conter no inicio save. Ex. saveInstances. get - Se for um método para enviar informação para a base dados local, deve sempre conter no inicio get. Ex. getInstances.


ZSAPI 11 / 144


Pedidos | Requests Endereço do serviço (desde dezembro 2014):

https://api.zonesoft.org

Nota: O endereço de serviço https://api.zsrestweb.com (usado anteriormente) será suportado até novembro 2015. A ZSAPI utiliza a seguinte estrutura de URL, em cada Request independentemente do tipo de Cliente que acede:

https://api.zonesoft.org/vNúmero_da_versão/nome_da_interface/nome_da_Ação

como por exemplo:

https://api.zonesoft.org/v1.1/documents/getInstances

em que:

1. https://api.zonesoft.org/ - endereço do servidor 2. v1.1/ - a versão da ZSAPI que se pretende usar 3. documents/ - Entidade ou, Interface que vai processar o Request 4. getInstances - o nome da Ação dentro da Interface que vai processar o Request.

Apenas são suportados Requests POST e GET. Qualquer outro tipo de Request originam Response StatusCode::ZSAPI_BAD_REQUEST 400. São suportados os seguintes headers CONTENT_TYPE do protocolo HTTP:

● application/x-www-form-urlencoded ● multipart/form-data ● application/json

É obrigatório indicar a versão da API para cada pedido através do URL do Request e este deverá ser o primeiro parâmetro, logo a seguir ao endereço https do serviço. Exemplo:


ZSAPI 12 / 144


curl -k https://api.zonesoft.org/v1.1/auth/authenticate

ou:

curl -k https://api.zonesoft.org/v1/auth/authenticate

Nota: a definição da versão da API deve ser o primeiro item logo a seguir ao endereço http do serviço como no exemplo acima: https://api.zonesoft.org/v1/ - não obedecer a esta regra pode originar uma resposta (Response) diferente da esperada. Atenção: Caso a versão não seja definida no pedido (Request), a resposta (Response) pode ser diferente da que era esperada.


ZSAPI 13 / 144


Respostas Por defeito o tipo resposta é no formato JSON. Formatos suportados:

● JSON Nota: Suporte a XML e TEXT está previsto em versões futuras. Numa abordagem ideal o Cliente deverá converter a Response para um objecto em que as suas propriedades serão StatusCode, StatusMessage e o objecto Content. O cliente deve analisar o Response.SatusCode antes de processar o Response.Content. Exemplo 5 (pseudo-código):

if(Response.StatusCode === 300){ (ocorreu um erro ao processar o pedido)

}else{ (tudo ok, Pode processar o Response.Content - mas é aconselhável verificar o valor

Response.Status antes de processar o Response.Content ) }

Consultar Anexo I - Tabela de códigos para Response.StatusCode

Respostas - Listagens Todos os Requests que originem listagens como Respostas estão limitados por defeito ao máximo de 250 instancias da entidade pedida/retornada. Este limite pode ser alterado no próprio Request para qualquer valor compreendido entre [1, 250]. Sempre que é feito um Request para obter uma lista de instâncias, a lista de instâncias será


ZSAPI 14 / 144


fornecida no objecto Response.Content que terá uma propriedade com o nome singular em minúsculas da Interface pedida, essa propriedade será um Array que conterá as instâncias pedidas - Existem no entanto algumas excepções devidamente identificadas. Todos os argumentos apresentados na tabela abaixo podem ser definidos a cada Request para uma Interface. Para tal, têm de ser encapsulados numa entidade com o nome em minúsculas e no singular da Interface da ZSAPI que irá processar o pedido. Argumentos disponíveis por Request de listagem:

Argumento Obrigatório Tipo Defeito Descricão

entidade_modelo [limit] NÂO integer ilimitado Número de registos a obter.

entidade_modelo [offset] NÂO integer 0 Número de registos a partir dos quais se quer obter a listagem.

entidade_modelo [order] NÂO string ‘’’ Ordenação da listagem: Deve obedecer ao seguinte padrão; nome_da_propriedade[,nome_da_propriedade1,nome_da_propriedade2] ; sentido O sentido poder ser uma das seguintes opções: ASC, DESC.

entidade_modelo [group] NÂO string ‘’ Propriedades a agrupar.

entidade_modelo [condition] NÂO string ‘’ Critérios extra de pesquisa.

Exemplo de Request Curl à Interface documents - Entidade a usar document :

curl -k https://api.zonesoft.org/v1/documents/getDocuments/ -H 'Content-type: application/json' -X POST -d '{

"auth_hash"="ae31086e04893bf262ebff7d4fd80326a7a01ecd", ”document”:{"limit":100,”offset”:150}

}'

Nota: A combinação dos argumentos limit e offset permite fazer navegação entre pedidos de listagens a uma mesma interface, à semelhança das queries SQL. Respostas status: ZSAPI_UNPROCESSABLE_ENTITY (422) Sempre que é feito um Request que retorne uma resposta com o status ZSAPI_UNPROCESSABLE_ENTITY: 422, é acrescentada uma nova propriedade _errors


ZSAPI 15 / 144


a cada instancia com erro, indicando os erros de validação encontrados na instancia. A propriedade _errors, quando definida, retorna uma lista (Array) em que cada elemento tem a seguinte estrutura:

{ “property”: nome_da_propriedade_com_erro (string), “error”: descricao_erro_encontrado (string) }

Exemplo de Response ZSAPI_UNPROCESSABLE_ENTITY:

{“store”:{ (...) , _errors:[{

“property”: “codigo”, “error”: “Codigo must be an integer” } ]

(...) }

}

Convenções para tipos de dados:

Tipo de dados Formato convencionado Exemplo Descrição

date YYYY-MM-DD 2001-01-01 Data ISO 8601

datetime YYYY-MM-DD hh:mm:ss 2001-01-01 08:30:25 Data/hora ISO 8601


ZSAPI 16 / 144


Acesso A ZSAPI está disponível apenas para os Clientes da ZoneSoft que estejam devidamente licenciados para esse efeito. Para aceder aos serviços da ZSAPI todos os utilizadores são submetidos a um processo de autenticação. Todos os Requests de autenticação deverão ser executados à interface Auth no seguinte URL

https://api.zonesoft.org/v1/auth/authenticate

Após a autenticação inicial (com sucesso) é retornada uma auth_hash que deverá ser adicionada a todos os requests. Essa auth_hash servirá para validar e autenticar os pedidos subsequentes. Exemplo 1.: - Exemplo para realizar um pedido JSON

{ "auth_hash"="ae31086e04893bf262ebff7d4fd80326a7a01ecd",

"document":{"codigo":"10014","loja":"111"} }

A auth_hash é valida por utilizador/loja. Em cada Request, se a auth_hash fornecida é válida para o utilizador/loja, o período limite de duração da sessão é extendido e o Request é processado normalmente. A mensagem retornada será específica para o Request.


ZSAPI 17 / 144



ZSAPI 18 / 144


Interfaces ZSAPI

Interface::Auth Interface responsável por processar todos os Requests relativos ao processo de autenticação dos utilizadores e a respetiva autorização de acesso aos serviços ZSAPI.

Ação::authenticate Permite autenticar e autorizar um utilizador para usar os serviços ZSAPI.

Argumentos:

Argumento Obrigatório Tipo Descricão

user [nif] SIM string NIF de associado ao utilizador.

user [nome] SIM string Username do utilizador.

user [password] SIM string Password do utilizador.

user [loja] SIM integer Código de identificação da loja.

Exemplo de um Request JSON:

{ "user":{

"nif":"999999999","nome":"tablet1","password":"userpass",”loja”:1 }

}

Respostas:

Código Resposta Descrição

StatusCode:ZSAPI_AUTHORIZED (200) As credenciais são válidas e uma auth_hash é retornada.


ZSAPI 19 / 144


StatusCode::ZSAPI_UNAUTHORIZED (401) As credenciais fornecidas não são válidas.

StatusCode::ZSAPI_HD_FAIL (900) Já existe uma sessão iniciada com as credencias fornecidas.

StatusCode::ZSAPI_BAD_REQUEST (400) Request mal formado.

Exemplo de resposta em JSON StatusCode::ZSAPI_OK (200):

{ "Response":{

"StatusCode":200,"StatusMessage":"Authorized","Content":{“auth_hash”:”AA299SJ37HBLOFF”} }

}

Ação::logout Permite terminar a sessão ativa do utilizador nos serviços ZSAPI.

Argumentos:


auth_hash SIM string A auth_hash válida retornada no processo de autenticação..


{"auth_hash":"AA299SJ37HBLOFF"}

Respostas:


StatusCode:ZSAPI_OK (200) A sesão foi terminada com sucesso.

StatusCode::ZSAPI_UNAUTHORIZED (401) A auth_hash fornecida não é válida.



{"Response":{"Code":200,"Message":"OK"}}


ZSAPI 20 / 144


Interface::SalesSessions Interface responsável por processar todos os Requests relativos às sessões de venda - caixa. Entidades modelo : SaleSession

Ação::getSaleSession Criar uma sessão de vendas. Para abrir uma sessão é necessário que o dia esteja previamente aberto. Se já existir uma sessão de vendas aberta, essa sessão é retornada.

Argumentos:


salesession[caixa] SIM integer Número/código da caixa.

salesession[opencx] SIM string Nome do operador.

salesession[empid] SIM integer Código do operador.

Exemplo de request em JSON:

(...) "salesession":[

{"caixa":1,”opencx”:”Operador 1”,”empid”:125} ]

(...)

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “salesession” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.


ZSAPI 21 / 144


StatusCode::ZSAPI_UNPROCESSABLE_ENTITY (422)

O dia não foi inciado/aberto para vendas.



(...) "salesession":{"idcx":12,”caixa”:1,"data":"2013-01-01",(...)} (...)

Ação::closeSaleSession Fechar a sessão de vendas em uso. Argumentos:



salesession[opencx] SIM string Nome do operador.

salesession[idcx] SIM integer Código da sessão em uso.

salesession[empid] SIM integer Código do operador.

salesession[data] SIM date Data de abertura da sessão retornada na resposta da ação: getSaleSession.


(...) "salesession":{”caixa”:2,”opencx”:”Operador 1”,"idcx":1,”empid”:1,”data”:”2013-01-01”} (...)

Respostas:


StatusCode::ZSAPI_OK (200) A sessão foi fechada com sucesso - é retornada uma instância no atributo “salesession” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.


ZSAPI 22 / 144



Ocorre um erro ao fechar a Sessão. Deve consultar a mensagem retornada.


Ação::getSalesDay Obter uma a instancia do último dia de vendas presente na base de dados. Entidade modelo : SalesDay Argumentos: Sem argumentos até a versão 1.5 , depois da 1.6 passa a receber argumentos. Exemplo de request em JSON:

(...) "salesday":{"caixa":1, "data":"2012-11-09"} (...)

Respostas:


StatusCode::ZSAPI_OK (200) É retornada uma instância no atributo “salesday” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NOT_FOUND (404) Não foi encontrada nenhuma instancia.

Ação::saveSalesDaysInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem inseridos/atualizados na base de dados. Entidade modelo : SalesDay

Argumentos:



ZSAPI 23 / 144


salesday SIM array | json object Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:


StatusCode::ZSAPI_CREATED (201) Todas as instâncias foram gravadas com sucesso.


Ocorreu um erro ao tentar gravar pelo menos uma das instâncias. A(s) instância(s) com erro não foram gravadas. Deve consultar a mensagem recebida.


Nota: Nota cada instância a ser processada deverá obedecer à estrutura completa da Entidade Modelo.

Ação::getOpenSaleSession Retorna a instancia da Entidade Modelo pedida. Entidade modelo : SaleSession

Argumentos:



salesession[data] SIM date Data de abertura da sessão a pesquisar.


(...) "salesession":{”caixa”:2,”data”:”2013-01-01”} (...)

Respostas:


StatusCode::ZSAPI_OK (200) A sessão foi fechada com sucesso - é retornada uma instância no atributo “salesession” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.


ZSAPI 24 / 144


StatusCode::ZSAPI_NO_CONTENT (204) Não foi encontrada a sessão.


Ação::saveSaleSession Processa uma lista (Array) de instâncias da Entidade Modelo para serem inseridos na base de dados. Entidade modelo : SaleSession

Argumentos:


salesday SIM array | json object Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:




Ocorreu um erro ao tentar gravar pelo menos uma das instâncias. A(s) instância(s) com erro não foram gravadas. Deve consultar a mensagem recebida.



Interface::Documents Interface responsável por processar todos os Requests relativos aos documentos - documents.


ZSAPI 25 / 144


Entidade modelo : Document Entidades relacionadas : Sale, Store, PaymentDoc, Counterbalance

Ação::getInstance Retorna a instância da Entidade Modelo pedida. Argumentos:


document[doc] SIM string(2) O código de caracteres para identificação do tipo de documento.

document[serie] SIM string(20) A identificação da série do documento.

document[numero] SIM integer O número do documento na série fornecida.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "document":{

"numero":"1","doc":"AD","serie":"1L111025" }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “document” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foi encontrada a instância pedida.


Ação::getInstances


ZSAPI 26 / 144


Retorna uma lista (Array) de instâncias completas (com as respetivas entidades dependentes) da Entidade Modelo. Argumentos: Opcional usar os argumentos para as listagens. Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “document” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontradas instâncias desta Entidade Modelo.



(...) "document":[

{"numero":"1","doc":"RC","serie":"1L111025"}, {"numero":"122","doc":"FA","serie":"1L111025"}

] (...)

Nota: ver informação sobre listagens.

Ação::getDocumentsHeaders Retorna uma lista (Array) de instâncias Entidade Modelo apenas com os cabeçalhos de documentos. Argumentos: Opcional usar os argumentos para as listagens. Respostas:


StatusCode::ZSAPI_OK (200) Os documentos são retornados na Resposta no atributo “document” do tipo Array <Entidade Modelo>. - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foi encontrado o documento pedido.


ZSAPI 27 / 144




(...) "document":[

{"numero":"1","doc":"RC","serie":"1L111025"}, {"numero":"122","doc":"FA","serie":"1L111025"}

] (...)


Ação::saveInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem inseridos/atualizados na base de dados. Nota:

Para instâncias da Entidade Modelo provenientes de outros softwares certificados, a propriedade ATDocCodeSource terá o seu valor alterado para ‘I’ (i maiúsculo) e a propriedade hashcontrol2 deverá estar preenchida com o número da certificação do software de origem e o número da versão da hash acordo com a legislação. A propriedade hash deverá conter a a hash gerada no software original. Tanto a propriedade hash como a propriedade hashcontrol2 são obrigatórias quando o documento a ser integrado é comunicado no SAFT, documentos do tipo: 'TK', 'VD', 'FA', 'FS', 'FT', 'GT', 'GR', 'TA', 'GD', 'CM', 'RC'.

Argumentos:


document SIM array | json object Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:



StatusCode::ZSAPI_UNPROCESSABLE_ENTITY Ocorreu um erro ao tentar gravar pelo menos uma das


ZSAPI 28 / 144


(422)

instâncias ou uma das suas Entidades Relacionadas (Sales, PaymentDocs, CounterBalances). A(s) instância(s) com erro - incluindo as suas Entidades Relacionadas - não foram gravadas. Deve consultar a mensagem recebida.



Ação::setDocumentNull - deprecated na versão 1.5. Substituída por setInstanceAsNulled

Ação::setInstanceAsNulled Permite anular uma instância da Entidade Modelo.

Argumentos:





document [empanulado] SIM integer Código do operador que anulou o documento.

document [descanulado]

SIM string Descrição do motivo de anulação do documento.

document[data_alteracao]

SIM datetime Data de anulação do documento.



"numero":"1","doc":"AD","serie":"1L111025",”empanulado”:12,”descanulado”:”Devolução do Cliente” }


ZSAPI 29 / 144


}

Respostas:


StatusCode::ZSAPI_OK (200) É retornado a instância do Documento Anulado na Resposta sob o atributo “document” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.


Ocorreu um erro ao anular o Documento. Deve consultar a mensagem recebida.


Ação::getSale - deprecated na versão 1.5. Substituída por getSaleInstance

Ação::getSaleInstance Retorna a instância da Entidade Sale pedida. Entidade modelo : Sale Argumentos:


sale[doc] SIM string(2) O código de caracteres para identificação do tipo de documento.

sale[serie] SIM string(20) A identificação da série do documento.

sale[numero] SIM integer O número do documento na série fornecida.

sale[id] SIM integer Código de identificação do produto.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "sale":{

"numero":1,"doc":"FA","serie":"1L111025",”id”:1,(...)


ZSAPI 30 / 144


} }

Respostas:


StatusCode::ZSAPI_OK (200) A linha de venda é retornada na Resposta no atributo “sale” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foi encontrada a venda pedido.



(...) "sale":{"numero":1,”doc”:”FA”,”serie”:”1L111025”,”codigo”:1,(...)} }

(...)

Ação::getSalesFromDocument - deprecated na versão 1.5. Substituída por getSaleInstancesFromDocument

Ação::getSaleInstancesFromDocument Retorna uma lista (Array) contendo todas as instâncias da entidade Sale referentes a um documento. Consultar estrutura da Entidade - Sale. Entidade modelo : Document Argumentos:





ZSAPI 31 / 144



Respostas:


StatusCode::ZSAPI_OK (200) As vendas são retornadas na Resposta no atributo “sale” do tipo Array <Sale> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontradas vendas para o documento indicado ou o documento indicado não existe.



(...) "sale":[

{"numero":"1","doc":"AD","serie":"1L111025",”total”:22.00;”qtd”:221.1111,”codigo”:1,”descricao”:”Produto 1”,(...)}, {"numero":"2","doc":"AD","serie":"1L111025",”total”:212.00;”qtd”:1.1111,”codigo”:21,”descricao”:”Produto 21”,(...)},

]

(...)

Ação::getPaymentDocsFromDocument - deprecated na versão 1.5. Substituída por getPaymentDocInstancesFromDocument

Ação::getPaymentDocInstancesFromDocument Retorna uma lista (Array) contendo todas as instâncias da entidade PaymentDoc referentes a um documento cujo o tipo de pagamento seja 9 - pagamentos múltiplos. Consultar estrutura da Entidade - PaymentDoc.

Argumentos:




ZSAPI 32 / 144






"numero":"1","doc":"AD","serie":"1L111025" }

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornados na Resposta no atributo “paymentdoc” do tipo Array <PaymentDoc> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontrados Registos de Pagamentos para o documento indicado.



(...) "paymentdoc":[

{"numero":1,”doc”:”FA”,”serie”:”L1SAWT62”,”tipo”:1,(...)}, {"numero":1,”doc”:”FA”,”serie”:”L1SAWT62”,”tipo”:2,(...)} ]

} (...)

Ação::getCounterBalancesFromDocument - deprecated na versão 1.5. Substituída por getCounterBalancesInstancesFromDocument

Ação::getCounterBalancesInstancesFromDocument

Retorna uma lista (Array) contendo todas as instâncias da entidade CounterBalance referentes a um Documento.


ZSAPI 33 / 144


Consultar estrutura Entidade: CounterBalance. Argumentos:







"numero":"1","doc":"RC","serie":"1L111025" }

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornados na Resposta no atributo “counterbalance” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontradas Produtos.



(...) "counterbalance":[

{"rc":1,”rcSerie”:”L1SAWT62”,(...)}, {"rc":1,”rcSerie”:”L1SAWT62”,(...)} ]

} (...)


ZSAPI 34 / 144


Ação::saveATCode Permite guardar o código retornado pela AT para uma instância da Entidade Modelo.

Argumentos:





document[ATDocCodeID] SIM string Código fornecido pela AT.

document[ ATDocCodeSource]

SIM string(2) Um dos seguintes valores M - se foi introduzido manualmente; P - se foi registado de forma automática.



"numero":"1","doc":"AD","serie":"1L111025",”ATDocCodeID”:”EA12131DS”,”ATDocCodeSourceID”:”P” }

}

Respostas:


StatusCode::ZSAPI_OK (200) É retornada a instância do Documento Anulado na Resposta no atributo “document” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.


Ocorreu um erro ao anular o Documento. Deve consultar a mensagem recebida.



ZSAPI 35 / 144


Ação::getNumberDS - deprecated na versão 1.5. Substituída por getNumberDSInstances

Ação::getNumberDSInstances Usa como Entidade Modelo: Numdocserie Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo. Argumentos: Opcional usar os argumentos para as listagens. Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “numdocserie” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.



(...) "numdocserie":[

{“loja”:1,"numero":1,"doc":"RC","serie":"1L111025"}, {“loja”:1,"numero":122,"doc":"FA","serie":"1L111022"}

] (...)


Ação::saveNumberDS - deprecated na versão 1.5. Substituída por saveNumberDSInstances

Ação::saveNumberDSInstances Processa uma instância da Entidade Modelo para ser inserido na base de dados. Usa como Entidade Modelo: Numdocserie


ZSAPI 36 / 144


Argumentos:


numdocserie SIM JSON object Um JSON Object do tipo <Entidade Modelo>.

Exemplo de pedido em JSON:

(...) "numdocserie":[

{"numero":1,"doc":"RC","serie":"1L111025"}, {"numero":122,"doc":"FA","serie":"1L111022"}

] (...)

Respostas:


StatusCode::ZSAPI_CREATED (201) A instância foi processada com sucesso.


Ocorreu um erro ao tentar gravar a instância. Deve consultar a mensagem recebida.


Nota: A instância a ser processada deverá obedecer à estrutura completa da Entidade Modelo.

Ação::saveATInstance - deprecated na versão 1.5. Substituída por saveATTransportInstance

Ação::saveATTransportInstance Permite usar a ZSAPI para comunicar um documento de transporte à AT. Caso o documento seja comunicado com sucesso será processado para ser guardado na base de dados.

Argumentos:


document SIM JSON object Uma instancia JSON Object do tipo <Entidade Modelo>.

Respostas:


ZSAPI 37 / 144



StatusCode::ZSAPI_OK (201) A instância foi processada com sucesso. Deverá consultar os códigos de resposta para agir em conformidade. Será retornada uma instancia de ATResponse - deverá consultar a Estrutura de Entidade ATResponse.


A instancia recebida não é válida. Deve consultar a mensagem recebida.


Nota: Cada instância a ser processada deverá obedecer à estrutura completa da Entidade Modelo.

Interface::Products Interface responsável por processar todos os Requests relativos aos produtos - products. Entidade Modelo : Product Entidades Relacionadas : Unit, Family, SubFamily, Store, ExemptionReason



product [codigo] SIM integer Número/código do Produto.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f",


ZSAPI 38 / 144


"product":{ "codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “product” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.



Ação::getInstances Retorna uma lista (Array) de instâncias da Entidade Modelo. Argumentos: Opcional usar os argumentos para as listagens.

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “product” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "product":[

{"codigo":1,"descricao":"Manteiga”,(...)}, {"codigo":2,"descricao":"Porta da Ravel”,(...)} ]

(...)


ZSAPI 39 / 144



Ação::saveInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem inseridos/atualizados na base de dados. Argumentos:


product SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:


StatusCode::ZSAPI_CREATED (201) As instâncias foram processadas com sucesso.


Ocorreu um erro ao tentar gravar pelo menos uma das instâncias. A(s) instância(s) com erro não foram guardada(s). Deve consultar a mensagem recebida.


Nota: Nas situações de atualização de produtos com vendas associadas apenas serão guardadas as modificações permitidas por lei.

Nota: Cada instância da Entidade Modelo a ser processada deverá obedecer à estrutura da Entidade Modelo.

Ação::deleteInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem removidos da base de dados. Argumentos:



ZSAPI 40 / 144


product SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância Product dentro do Array deve obedecer à seguinte estrutura:

product [codigo] SIM integer Número/código do produto.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "product":[

{"codigo":11}, {"codigo":12} ]

}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “product” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.


Ocorreu um erro ao tentar remover pelo menos uma das instâncias. A(s) instância(s) com erro não foram removida(s). Deve consultar a mensagem recebida.


Nota: Só podem ser removidos instâncias da Entidade Modelo que não estejam associados a transações.

Ação::getInstancesToSync Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham sofrido alterações numa data/hora superior ou igual ao valor fornecido no pedido.


ZSAPI 41 / 144


Argumentos:


product[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “product”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “product” do tipo Array - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontradas instâncias desta Entidade Modelo para sincronizar.



Ação::setFullSync Marcar todas as instâncias da Entidade Modelo para serem sincronizadas. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f" }

Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância do tipo <Entidade Modelo> no atributo “product”.

StatusCode::ZSAPI_NOT_MODIFIED (304) Não foram encontradas instâncias da Entidade Modelo


ZSAPI 42 / 144


- Certifique-se de que existem registos na base de dados.


Ação::getInstancesToDelete Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham sido marcadas para remoção da base de dados desde a data fornecida. Argumentos:


product[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “product”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “product” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontradas instâncias da Entidade Modelo - Certifique-se de que existem registos na base de dados.


Interface::ExemptionReasons


ZSAPI 43 / 144


Interface responsável por processar todos os Requests relativos aos motivos de isenção - exemptionReason. Entidades modelo : ExemptionReason



exemptionReason [codigo]

SIM integer Número/código do Motivo de Insenção.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "exemptionreason":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “exemptionreason” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.



Ação::getInstances Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo. Argumentos: Opcional usar os argumentos para as listagens.


ZSAPI 44 / 144


Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “exemptionreason” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "exemptionreason":[

{"codigo":1,"descricao":"Loja Amadora”}, {"codigo":2,"descricao":"Loja Braga”}

] (...)




exemptionreason SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:




Ocorreu um erro ao tentar gravar pelo menos uma das instâncias. A(s) instância(s) com erro não foram guardada(s).


ZSAPI 45 / 144


Deve consultar a mensagem recebida.


Nota: Cada instância da Entidade Modelo a ser processada deverá obedecer à estrutura: Estrutura da Entidade Modelo.

Ação::deleteInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem removidos na base de dados. Argumentos:


exemptionreason SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância ExemptionReason dentro do Array deve obedecer à seguinte estrutura:

exemptionreason [codigo]

SIM integer Número/código do motivo de insenção.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "exemptionreason":[

{"codigo":’M01’}, {"codigo":’M02’} ]

}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “exemptionreason” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.


ZSAPI 46 / 144







Argumentos:


exemptionreason [lastupdate]

SIM datetime Timestamp de verificação.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “exemptionreason”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “exemptionreason” do tipo Array - consultar documento sobre estrutura da entidade.





ZSAPI 47 / 144




Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância - vazia do tipo <Entidade Modelo> no atributo “exemptionreason”.

StatusCode::ZSAPI_NOT_MODIFIED (304) Não foram encontradas instâncias da Entidade Modelo - Certifique-se de que existem registos na base de dados.




exemptionreason[lastupdate]



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “exemptionreason”:{”lastupdate”: “2012-01-01 00:00:00”}

}


ZSAPI 48 / 144


Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “exemptionreason” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.



Interface::Stores Interface responsável por processar todos os Requests relativos às lojas - store. Entidade Modelo : Store Entidades relacionadas: StoreSettings



store [codigo] SIM integer Número/código da Store. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "store":{

"codigo":2 }

}


ZSAPI 49 / 144


Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “store” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.



Ação::getInstances Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo.

Argumentos: Opcional usar os argumentos para as listagens. Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “store” do tipo Array - consultar documento sobre estrutura da entidade.




(...) "store":[

{"codigo":1,"descricao":"Loja Amadora”}, {"codigo":2,"descricao":"Loja Braga”} ]

(...)



ZSAPI 50 / 144


Ação::saveInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem atualizados na base de dados. Nota: Apenas os campos relativos ao endereço e à descrição podem ser alterados. Argumentos:


store SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:






Nota: Cada instância a ser processada deverá obedecer à estrutura Entidade Modelo.

Ação::getInstanceWithSettings Retorna a instância da Entidade Modelo pedida com a propriedade StoreSettings preenchida com um Array de instancias StoreSettings deve consultar a Estrutura da Entidade StoreSettings. Argumentos:


store [codigo] SIM integer Número/código da Store. Exemplo de um Request JSON:



ZSAPI 51 / 144


"store":{ "codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “store” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.



Interface::Units Interface responsável por processar todos os Requests relativos às unidades - units. Entidade Modelo : Unit



unit [codigo] SIM integer Número/código da Unit. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "unit":{

"codigo":2 }

}


ZSAPI 52 / 144


Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “unit” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “unit” do tipo Array - consultar documento sobre estrutura da entidade.




(...) "unit":[

{"codigo":1,"descricao":"Unidade”}, {"codigo":2,"descricao":"Pack 6”}

] (...)



ZSAPI 53 / 144




unity SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "unit": [ {"codigo":132,"descricao":"NovaUnidade2"}, {"codigo":131,"descricao":"NovaUnidade1"} ] }

Respostas:






Nota: Cada instância a ser processada deverá obedecer à estrutura da Entidade Modelo.



ZSAPI 54 / 144



unit SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância Unit dentro do Array deve obedecer à seguinte estrutura:

unit [codigo] SIM integer Número/código da unidade.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "unit":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias são retornadas na Resposta no atributo “unit” do tipo Array - consultar documento sobre estrutura da entidade.







ZSAPI 55 / 144


Argumentos:


unit [lastupdate] SIM datetime Timestamp de verificação.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “unit”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “unit” do tipo Array - consultar documento sobre estrutura da entidade.





Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância - vazia do tipo <Entidade Modelo> no atributo “unit”.



ZSAPI 56 / 144





unit[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “unit”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) Content está vazio.



Interface::Families Interface responsável por processar todos os Requests relativos às instâncias das famílias dos produtos - families. Entidades modelo: Family Entidades relacionadas: SubFamily


ZSAPI 57 / 144




family [codigo] SIM integer Número/código da Familia.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "family":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “family” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo


ZSAPI 58 / 144


“family” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "family":[

{"codigo":1,"descricao":"Entradas”,”frontoffice”:1,”posicaofront”:100,”posicaoprint”:1,”fundo”:1,”letra”:1,”subfamilias”:[{subfam1}, {subfam2}]}, {"codigo":2"descricao":"Acompanhamentos”,”frontoffice”:1,”posicaofront”:102,”posicaoprint”:12,”fundo”:1,”letra”:1,}

] (...)




family SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:






ZSAPI 59 / 144



Nota: Cada instância da Entidade Modelo a ser processada deverá obedecer à estrutura Entidade Modelo.

Ação::deleteInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem removidos na base de dados - inclusive as suas subfamílias. Argumentos:


family SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância Family dentro do Array deve obedecer à seguinte estrutura:

family [codigo] SIM integer Número/código da familia.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "family":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias são retornadas na Resposta no atributo “family” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




ZSAPI 60 / 144



Nota: Só podem ser removidos instâncias da Entidade Modelo que não estejam associados a transações e que não tenham subfamílias associadas a transações.


Argumentos:


family [lastupdate] SIM datetime Timestamp de verificação.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “family”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “family” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "family":[

{"codigo":1,"descricao":"Entradas”,”frontoffice”:1,”posicaofront”:100,”posicaoprint”:1,”fundo”:1,”letra”:1,}, {"codigo":2"descricao":"Acompanhamentos”,”frontoffice”:1,”posicaofront”:102,”posicaoprint”:12,”fundo”:1,”letra”:1,}


ZSAPI 61 / 144


] (...)


Ação::setFullSync Marcar todas as Entidades Modelo para serem sincronizadas. Exemplo de um Request JSON:


Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância (vazia) do tipo <Entidade Modelo> no atributo “family”.



Ação::getSubFamily - deprecated na versão 1.5. Substituída por getSubFamilyInstance

Ação::getSubFamilyInstance Usa como Entidade Modelo : SubFamily Retorna uma instância da Entidade Modelo pedida. Argumentos:


subfamily [codigo] SIM integer Número/código da SubFamilia.


ZSAPI 62 / 144



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "subfamily":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância (vazia) do tipo <Entidade Modelo> no atributo “subfamily” - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foi encontrado o tipo de pagamento pedido.


Ação::getSubFamiliesFromFamily - deprecated na versão 1.5. Substituída por getSubFamiliesInstancesFromFamily

Ação::getSubFamiliesInstancesFromFamily Usa como Entidade Modelo : Family

Retorna uma lista (Array) contendo todas as instâncias da Entidade SubFamily duma Familia. Argumentos:


family [codigo] SIM integer Número/código da familia.

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “subfamily” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontradas Sub Famílias.


ZSAPI 63 / 144




(...) “subfamily":[

{"codigo":1,"descricao":"Com Gás”,”familia”:1,”fundo”:100,”letra”:1,”posicao”:1}, {"codigo":2,"descricao":"Sem Gás”,”familia”:1,”fundo”:100,”letra”:1,”posicao”:2}

] } (...)

Ação::saveSubFamilies - deprecated na versão 1.5. Substituída por saveSubFamiliesInstances

Ação::saveSubFamiliesInstances Usa como Entidade Modelo : SubFamily

Processa uma lista (Array) de instâncias da Entidade Modelo para serem inseridos/atualizados na base de dados. Argumentos:


subfamily SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:






Nota: Cada instância da Entidade Modelo a ser processada deverá obedecer à estrutura da Entidade


ZSAPI 64 / 144


SubFamily.

Ação::deleteSubFamilies - deprecated na versão 1.5. Substituída por deleteSubFamiliesInstances

Ação::deleteSubFamiliesInstances Usa como Entidade Modelo : SubFamily Processa uma lista (Array) de instâncias da Entidade Modelo para serem removidos na base de dados. Argumentos:


subfamily SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância SubFamily dentro do Array deve obedecer à seguinte estrutura:

subfamily [codigo] SIM integer Número/código da subfamilia.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "subfamily":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias são retornadas na Resposta no atributo “subfamily” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.


Ocorreu um erro ao tentar remover pelo menos uma das instâncias.


ZSAPI 65 / 144


A(s) instância(s) com erro não foram removida(s). Deve consultar a mensagem recebida.


Nota: Só podem ser removidos instâncias da Entidade SubFamily que não estejam associados a transações.

Ação::getSubFamiliesToSync - deprecated na versão 1.5. Substituída por getSubFamiliesInstancesToSync

Ação::getSubFamiliesInstancesToSync Usa como Entidade Modelo : SubFamily Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham sofrido alterações numa data/hora superior ou igual ao valor fornecido no pedido.

Argumentos:


subfamily [lastupdate] SIM datetime Timestamp de verificação.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “subfamily”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “subfamily” do tipo Array - consultar documento sobre estrutura da entidade.




ZSAPI 66 / 144



Ação::setSubFamiliesFullSync Marcar todas as instâncias da Entidade Subfamily para serem sincronizadas. Exemplo de um Request JSON:


Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância - vazia do tipo <Entidade Modelo> no atributo “subfamily”.

StatusCode::ZSAPI_NOT_MODIFIED (304) Não foram encontradas instâncias desta Entidade Modelo. (Subfamily). Certifique-se de que existem subfamilias na base de dados.




family[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:



ZSAPI 67 / 144


“family”:{”lastupdate”: “2012-01-01 00:00:00”} }

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “family” do tipo Array - consultar documento sobre estrutura da entidade.



Ação::getSubFamiliesToDelete - deprecated na versão 1.5. Substituída por getSubFamiliesInstancesToDelete

Ação::getSubFamiliesInstancesToDelete Usa como Entidade Modelo : SubFamily Retorna uma lista (Array) contendo todas as instâncias da Entidade Subfamily que tenham sido marcadas para remoção da base de dados. Argumentos:


subfamily[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “subfamily”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo


ZSAPI 68 / 144


“subfamily” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.



Interface::PaymentTypes Interface responsável por processar todos os Requests referentes aos tipos de pagamentos disponíveis - paymentTypes. Entidades modelo : PaymentType



paymenttype [codigo] SIM integer Número/código do tipo de pagamento.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "paymenttype":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo


ZSAPI 69 / 144


“paymenttype” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.




Argumentos: Opcional usar os argumentos para as listagens.

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “paymentType” do tipo Array <Entidade Modelo>- consultar documento sobre estrutura da entidade.




(...) "paymenttype":[

{"codigo":1,"descricao":"Cartão Débito”}, {"codigo":1,"descricao":"Cartão Crédito”}

] (...)


Ação::saveInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem inseridos/atualizados na base de dados.


ZSAPI 70 / 144


Argumentos:


paymenttype SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:









paymenttype SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância PaymentType dentro do Array deve obedecer à seguinte estrutura:

paymenttype [codigo] SIM integer Número/código do tipo de pagamento.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "paymenttype":[


ZSAPI 71 / 144



}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “paymentType” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.






Argumentos:


paymenttype [lastupdate]



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “paymenttype”:{”lastupdate”: “2012-01-01 00:00:00”}

}


ZSAPI 72 / 144


Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “paymentType” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.






Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância - vazia do tipo <Entidade Modelo> no atributo “paymentType”.



Ação::getInstancesToDelete Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham sido marcadas para remoção da base de dados desde a data fornecida.


ZSAPI 73 / 144


Argumentos:


paymenttype [lastupdate]



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “paymenttype”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “paymentType” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.



Interface::Taxes Interface responsável por processar todos os Requests relativos aos impostos disponíveis - tax. Entidades modelo : Tax



ZSAPI 74 / 144



tax [codigo] SIM integer Número/código do Iva. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "tax":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “tax” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “tax” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.





ZSAPI 75 / 144


(...) "tax":[

{"codigo":1,"descricao":"IVA 23%",”factor”:23,”activa”:1}, {"codigo":2,"descricao":"IVA 16%",”factor”:16,”activa”:0}

] (...)




tax SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:







Ação::deleteInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem removidos da base de dados.


ZSAPI 76 / 144


Argumentos:


tax SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância Tax dentro do Array deve obedecer à seguinte estrutura:

tax [codigo] SIM integer Número/código do tax.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "tax":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias são retornadas na Resposta no atributo “tax” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




Nota: Só podem ser removidos instâncias da Entidade Modelo que não estejam associados a transações..



ZSAPI 77 / 144


Argumentos:


tax[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “tax”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “tax” do tipo Array <Entidade Modelo>- consultar documento sobre estrutura da entidade.






Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância - vazia do tipo <Entidade Modelo> no atributo “tax”.


ZSAPI 78 / 144




Ação::deactivateTaxes - deprecated na versão 1.5. Substituída por setInstancesAsInactive

Ação::setInstancesAsInactive Processa uma lista (Array) de instâncias da Entidade Modelo para serem marcados como inactivos.

Argumentos:


tax SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância Tax dentro do Array deve obedecer à seguinte estrutura:

tax [codigo] SIM integer Número/código do iva.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "tax":[

{"codigo":11}, {"codigo":12}

] }

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias do pedido são retornadas na Resposta no atributo “tax” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.

StatusCode::ZSAPI_UNPROCESSABLE_ENTITY Ocorreu um erro ao tentar processar pelo menos uma


ZSAPI 79 / 144


(422) das instâncias. A(s) instância(s) com erro não foi(foram) processada(s). Deve consultar a mensagem recebida.


Ação::getActiveTaxes - deprecated na versão 1.5. Substituída por getActiveInstances

Ação::getActiveInstances Retorna uma lista (Array) de todos os Ivas ativos.

Argumentos: Opcional usar os argumentos para as listagens.

Respostas:






(...) "tax":[

{"codigo":1,"descricao":"IVA 23%",”factor”:23,”activa”:1}, {"codigo":3,"descricao":"IVA 5%",”factor”:5,”activa”:1}

] (...)


Ação::getInstancesToDelete Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham


ZSAPI 80 / 144


sido marcadas para remoção da base de dados desde a data fornecida. Argumentos:


tax[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “tax”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:





Interface::Clients Interface responsável por processar todos os Requests relativos aos clientes - clients. Entidades modelo : Client

Ação::getInstance Retorna a instância da Entidade Modelo pedida.


ZSAPI 81 / 144


Argumentos:


client [codigo] SIM integer Número/código do cliente. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "client":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “client” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “client” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




ZSAPI 82 / 144



(...) "client":[

{"codigo":12,"nome":"André Schneider",”morada”:””,(...)}, {"codigo":12,"nome":"André Schneider",”morada”:””,(...)}

] (...)




client SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:






Nota: Cada instância ser processada deverá obedecer à estrutura da Entidade Modelo.



ZSAPI 83 / 144


Argumentos:


client SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância dentro do Array deve obedecer à seguinte estrutura:

client [codigo] SIM integer Número/código do cliente.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "client":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “client” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.





Ação::getInstancesToSync Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham


ZSAPI 84 / 144


sofrido alterações numa data/hora superior ou igual ao valor fornecido no pedido.

Argumentos:


client[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “client”:{”lastupdate”: “2012-01-01 00:00:00”}

}


Respostas:







Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância - vazia do tipo <Entidade Modelo> no atributo “client”.


ZSAPI 85 / 144




Ação::deactivateClients - deprecated na versão 1.5. Substituída por setInstancesAsInactive

Ação::setInstancesAsInactive Processa uma lista (Array) de instâncias da Entidade Modelo para serem marcados como inativos na base de dados. Argumentos:


client SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.


client [codigo] SIM integer Número/código do cliente.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "client":[


}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias foram processadas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “client” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.


ZSAPI 86 / 144



Ocorreu um erro ao tentar processar pelo menos uma das instâncias. A(s) instância(s) com erro nsão retornadas na Resposta no atributo “client” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade. Deve consultar a mensagem recebida.




client[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “client”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:






ZSAPI 87 / 144


Interface::Operators Interface responsável por processar todos os Requests relativos aos operadores (empregados) - operators. Entidades modelo : Operator



operator [codigo] SIM integer Número/código do operador.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "operator":{"codigo":2} }

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “operator” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.





ZSAPI 88 / 144




StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “operator” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "operator":[

{"codigo":11,"foto":"",”bloqueado”:0,(...)}, {"codigo":12,"foto":"",”bloqueado”:1,(...)} ]

(...)




operator SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:




ZSAPI 89 / 144



Ocorreu um erro ao tentar gravar pelo menos uma das instâncias. A(s) instância(s) com erro não foram gravada(s). Deve consultar a mensagem recebida.




Argumentos:


operator SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.


operator [codigo] SIM integer Número/código do operador.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "operator":[


] }

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “operator” do tipo Array <Entidade Modelo> - consultar documento sobre


ZSAPI 90 / 144


estrutura da entidade.






Argumentos:


operator[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “operator”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “operator” do tipo Array - consultar documento sobre estrutura da entidade.





ZSAPI 91 / 144




Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância (vazia) do tipo <Entidade Modelo> no atributo “operator”.



Ação::getActiveOperators - deprecated na versão 1.5. Substituída por getActiveInstances

Ação::getActiveInstances Retorna uma lista (Array) contendo todas instâncias da Entidade Modelo que estejam assinaladas como ‘ativos’. Argumentos: Opcional usar os argumentos para as listagens. Respostas:



StatusCode::ZSAPI_NO_CONTENT (204) Não foram encontradas instâncias desta Entidade


ZSAPI 92 / 144


Modelo.



(...) "operator":[

{"codigo":11,"foto":"",”bloqueado”:0,(...)}, {"codigo":12,"foto":"",”bloqueado”:0,(...)} ]

(...)


Ação::getInactiveOperators - deprecated na versão 1.5. Substituída por getInactiveInstances

Ação::getInactiveInstances Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que estejam assinaladas como ‘inativos’.







(...) "operator":[

{"codigo":25,"foto":"",”bloqueado”:1,(...)}, {"codigo":18,"foto":"",”bloqueado”:1,(...)}


ZSAPI 93 / 144


] (...)


Interface::SalesStations Interface responsável por processar todos os Requests relativos aos postos de venda - salestation. Entidades modelo : SaleStation



salestation [codigo] SIM integer Número/código do posto. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "salestation":{"codigo":2} }

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “salestation” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.




ZSAPI 94 / 144


Ação::getInstanceWithSettings Idêntica à Ação::getInstance - Retorna a instância da Entidade Modelo pedida, com a propriedade SaleStationSettings preenchida com um Array de instâncias SaleStationSettings - deve consultar a Estrutura da Entidade SaleStationSettings.




StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “salestation” do tipo Array - consultar documento sobre estrutura da entidade.




(...) "salestation":[

{"codigo":11,"descricao":"Posto 11"}, {"codigo":12,"descricao":"Posto 11"} ]

(...)


Ação::getInstancesWithSettings Idêntica à Ação::getInstances - Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo e cada instancia tem a propriedade SaleStationSettings


ZSAPI 95 / 144


preenchida com um Array de instâncias SaleStationSettings - deve consultar a Estrutura da Entidade SaleStationSettings..



salestation SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:




Ocorreu um erro ao tentar gravar pelo menos uma das instâncias. A(s) instância(s) com erro não foram gravada(s). Deve consultar a mensagem recebida.




Argumentos:


salestation SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.


ZSAPI 96 / 144



salestation [codigo] SIM integer Número/código do posto.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "salestation":[


] }

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “salestation” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.






Argumentos:


salestation[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:


ZSAPI 97 / 144


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “salestation”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “salestation” do tipo Array - consultar documento sobre estrutura da entidade.






salestation[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “salestation”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “salestation” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.


ZSAPI 98 / 144




Interface::ProductStocks Interface responsável por processar todos os Requests relativos a obter stocks de produtos - productstock. Entidades modelo : ProductStock

Ação::getCurrentStockInstances Retorna uma lista (Array) contendo as instâncias da Entidade Modelo pedidas no request - os valores retornados são referentes à data em que é feito o pedido.

Argumentos:


productstock SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância dentro do Array do Request deve obedecer à seguinte estrutura:


productstock [loja] SIM integer Número/código do loja.

productstock [produto] SIM integer Número/código do produto.

productstock [armazem] Não integer Número/código do armazem.

productstock [uid_caracteristica]

Não integer Número/código da combinação de caracteristicas



ZSAPI 99 / 144


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "productstock":[

{"produto":11,”loja”:1}, {"produto":12,”loja”:1,”armazem”:1}, {"produto":12,”loja”:1,”armazem”:1,”uid_caracteristica”:1}

] }

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “productstock” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "productstock":[

{"produto":11,"loja":1,”stock”:232.22,”stkmin”:0,”stkmax”:1000.45,”data”:”2013-01-01”}, {"produto":12,"loja":1,”armazem”:1,”stock”:212.22,”stkmin”:0,”stkmax”:0,”data”:”2013-01-01”}, ]

(...)

Nota: Não se aplicam as opões das listagens.

Ação::getStockInstanceByDate Retorna uma instância da Entidade Modelo na data pedida. Argumentos:


productstock [loja] SIM integer Número/código do loja.



ZSAPI 100 / 144


productstock [data] SIM date Data na qual se quer obter a instancia

productstock [armazem] Não integer Número/código do armazem.

productstock [uid_caracteristica]

Não integer Número/código da combinação de caracteristicas


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "productstock":{"produto":11,”loja”:1,”data”:”2013-01-01”} }

Exemplo de um Request JSON para um armazém:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "productstock":{"produto":12,”loja”:1,”armazem”:1,”data”:”2013-01-01”} }

Exemplo de um Request JSON para um armazém e combinação de caracteristicas:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "productstock":{"produto":12,”loja”:1,”armazem”:1,”uid_caracteristica”:1} }

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “productstock” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade..

StatusCode::ZSAPI_NO_CONTENT (204) Não foi encontrada a instância desta Entidade Modelo.




{"produto":11,"loja":1,”stock”:232.22,”stkmin”:0,”stkmax”:1000.45,”data”:”2013-01-01”},


ZSAPI 101 / 144


{"produto":12,"loja":1,”armazem”:1,”stock”:212.22,”stkmin”:0,”stkmax”:0,”data”:”2013-01-01”}, {"produto":12,"loja":1,”armazem”:1,”stock”:212.22,”stkmin”:0,”stkmax”:0,”data”:”2013-01-01”}, ]

(...)


Ação::getCurrentStockInStores Retorna uma lista (Array) de instâncias da Entidade Modelo - uma instancia por loja - o valor de stock retornado é referente à data em que é feito o pedido. Se a caracteristica_id é fornecida nos pedidos, o valor da propriedade stock em cada instancia da resposta refere-se à quantidade existente, em cada loja, da combinação produto + combinações de caracteristicas em que caracteristica_id está presente. Se a caracteristica_id não é fornecida, o valor da propriedade stock em cada instancia da resposta retorna a quantidade existente do produto em cada loja - é retornada uma instancia por cada produto + combinação caracteristicas . A resposta apenas inclui instancias cujo o valor da propriedade ‘stock’ seja maior > 0. Na Resposta é retornada uma nova propriedade Store representando uma instancia da Entidade Modelo Store contendo informação de contacto da loja - ver exemplo de Resposta. Na Resposta é retornada uma nova propriedade descricao do tipo string representando o nome das combinação de caracteristicas associadas ao produto - ver exemplo de Resposta. Argumentos:


productstock SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância dentro do Array do Request deve obedecer à seguinte estrutura:




ZSAPI 102 / 144


productstock [caracteristica_id]

NÂO integer Número/código da caracteristica


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "productstock": {"produto":6,”caracteristica_id”:9} }

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “productstock” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.





{"loja":6,"produto":6,"uid_caracteristica":229,"stock":20,"data":"2014-03-27","descricao":"T SHIRT - Cor: Laranja, Tamanho: L","caracteristica_id":9,"Store":{"codigo":6,"descricao":"Teste Sonia","designacao":"Loja Teste Entroncamento","morada":"Rua ao pé da rotunda 23","numero_porta":"111","cod_postal":"1000-100","localidade":"Entroncamento"}}, {"loja":6,"produto":6,"uid_caracteristica":230,"stock":27,"data":"2014-03-27","descricao":"T SHIRT - Tamanho: XS, Cor: Azul","caracteristica_id":9,"Store":{"codigo":6,"descricao":"Teste Sonia","designacao":"Loja Teste Entroncamento","morada":"Rua ao pé da rotunda 23","numero_porta":"111","cod_postal":"1000-100","localidade":"Entroncamento"}}

] (...)


Interface::Suppliers


ZSAPI 103 / 144


Interface responsável por processar todos os Requests relativos aos fornecedores - suppliers. Entidades modelo : Supplier



supplier[codigo] SIM integer Número/código do fornecedor.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "supplier":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “supplier” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.







ZSAPI 104 / 144


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “supplier” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "supplier":[

{"codigo":12,"nome":"André Schneider",”morada”:””,(...)}, {"codigo":11,"nome":"Zone Soft",”morada”:””,(...)}

] (...)




supplier SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:







ZSAPI 105 / 144





supplier SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.


supplier [codigo] SIM integer Número/código do fornecedor.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "supplier":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “supplier” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




ZSAPI 106 / 144





Argumentos:


supplier[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “supplier”:{”lastupdate”: “2012-01-01 00:00:00”}

}


Respostas:







ZSAPI 107 / 144


Argumentos:


supplier[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “supplier”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:





Interface::Characteristics Interface responsável por processar todos os Requests relativos às caracteristicas - characteristics. Entidades modelo : Characteristics



ZSAPI 108 / 144



characteristic[id] SIM integer Número/código da caracteristica.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "characteristic":{

"id":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “characteristic” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “characteristic” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.





ZSAPI 109 / 144


(...) "characteristic":[

{"id":1,"valor":"Cor",”ativo”:0}, {"id":2,"nome":"Tamanhos",”ativo”:1}

] (...)




characteristic SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:









ZSAPI 110 / 144


Argumentos:


characteristic SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.


characteristic[id] SIM integer Número/código da caracteristica.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "characteristic":[

{"id":1}, {"id":2} ]

}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “characteristic” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.





Ação::getInstancesToSync Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham


ZSAPI 111 / 144


sofrido alterações numa data/hora superior ou igual ao valor fornecido no pedido.

Argumentos:


characteristic[lastupdate]



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “characteristic”:{”lastupdate”: “2012-01-01 00:00:00”}

}


Respostas:







characteristic[lastupdate]




ZSAPI 112 / 144


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “characteristic”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:





Interface::Couverts Interface responsável por processar todos os Requests relativos às couverts. Entidades modelo : Couvert Entidades relacionadas : Couvertzone



couvert[codigo] SIM integer Número/código da couvert.


{


ZSAPI 113 / 144


"auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "couvert":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “couvert” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “couvert” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "couvert":[

{"codigo":1,"descricao":"Entrada Azeitonas e Queijo",(...)}, {"codigo":2,"descricao":"Azeitonas",(...)}

] (...)


ZSAPI 114 / 144





couvert SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:









couvert SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.


ZSAPI 115 / 144



couvert[codigo] SIM integer Número/código da couvert.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "couvert":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “couvert” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.






Argumentos:


couvert[lastupdate] SIM datetime Timestamp de verificação.


ZSAPI 116 / 144



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “couvert”:{”lastupdate”: “2012-01-01 00:00:00”}

}


Respostas:







couvert[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “couvert”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:



ZSAPI 117 / 144





Interface::Technicalcards Interface responsável por processar todos os Requests relativos às fichas técnicas - technicalcard. Entidades modelo : Technicalcard Entidades relacionadas : Technicalcardingredient, Technicalcardpreparation



technicalcard[codigo] SIM integer Número/código da ficha técnica.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "technicalcard":{

"codigo":2 }

}

Respostas:


ZSAPI 118 / 144



StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “technicalcard” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “technicalcard” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "technicalcard":[

{"codigo":1,"empcriacao":1,(...)}, {"codigo":2,"empcriacao":1,(...)}

] (...)


Ação::saveInstances Processa uma lista (Array) de instâncias da Entidade Modelo para serem


ZSAPI 119 / 144


inseridos/atualizados na base de dados. Argumentos:


technicalcard SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:









technicalcard SIM Array Um Array de JSON Object do tipo <Entidade Modelo>.


technicalcard[codigo] SIM integer Número/código da ficha técnica.



ZSAPI 120 / 144


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "technicalcard":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias do pedido são retornadas na Resposta no atributo “technicalcard” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.






Argumentos:


technicalcard[lastupdate]



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “technicalcard”:{”lastupdate”: “2012-01-01 00:00:00”}


ZSAPI 121 / 144


}


Respostas:







ZSAPI 122 / 144


Argumentos:


technicalcard[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “technicalcard”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:





Interface::Tablemovements Interface responsável por processar todos os Requests relativos aos movimentos de mesas - tablemovement. Entidades modelo : Tablemovement




ZSAPI 123 / 144



StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “tablemovement” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "tablemovement":[

{"data":”2015-04-01”, "pessoas": 1,(...)}, {"data":”2015-04-01”,"pessoas": 21,(...)}

] (...)


Ação::getTableDetails Retorna uma lista (Array) contendo parte das instâncias da Entidade Modelo.

Argumentos:


tablemovement [inicio] SIM String Data inicial

tablemovement[fim] SIM String Data final


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "tablemovement": {

"inicio":"2014-01-01", "fim":"2014-01-31"

} }


ZSAPI 124 / 144


Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “tablemovement” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "tablemovement": [ { "mesa": "72", "lugar": "0", "pessoas": "1", "country": "PT" } ] (...)

Interface::ReasonBreaks Interface responsável por processar todos os Requests relativos motivos de quebra - reasonbreaks. Entidade Modelo : ReasonBreak



ZSAPI 125 / 144



reasonbreak [codigo] SIM integer Número/código da Unit. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "reasonbreak":{"codigo":2} }

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “reasonbreak” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “reasonbreak” do tipo Array - consultar documento sobre estrutura da entidade.




(...) "reasonbreak":[


ZSAPI 126 / 144


{"codigo":1,“descricao”:"Lixo",(...)}, {"codigo":2,“descricao”:"Fora de Prazo",(...)}

] (...)




reasonbreak SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "reasonbreak": [ {"codigo":1,"descricao":"Lixo",”reposicao”:1}, {"codigo":2,"descricao":"Fora de Prazo",”reposicao”:1} ] }

Respostas:








ZSAPI 127 / 144




reasonbreak SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância Reasonbreak dentro do Array deve obedecer à seguinte estrutura:

reasonbreak[codigo] SIM integer(11) Código do motivo de quebra


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "reasonbreak":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias são retornadas na Resposta no atributo “reasonbreak” do tipo Array - consultar documento sobre estrutura da entidade.




Nota: Só podem ser removidos instâncias da Entidade Modelo que não estejam associados a


ZSAPI 128 / 144


transações.

Ação::getInstancesToSync Retorna uma lista (Array) contendo todas as instâncias da Entidade Modelo que tenham sofrido alterações numa data/hora superior ou igual ao valor fornecido no pedido. Argumentos:


reasonbreak[lastupdate] SIM datetime Timestamp de verificação.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “reasonbreak”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “reasonbreak” do tipo Array - consultar documento sobre estrutura da entidade.




{"auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f"}

Respostas:



ZSAPI 129 / 144


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância - vazia do tipo <Entidade Modelo> no atributo “reasonbreak”.





reasonbreak[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “reasonbreak”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) Content está vazio.




ZSAPI 130 / 144


Interface::Categories Interface responsável por processar todos os Requests relativos às instâncias das categorias dos produtos - categories. Entidades modelo: Category Entidades relacionadas: SubCategory



category [codigo] SIM integer Número/código da Categoria.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "category":{

"codigo":2 }

}

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “category” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.




ZSAPI 131 / 144





StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “category” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "category": [ { "codigo": 1, "descricao": "Cafés", "loja": 1, "subcategories": [ { "codigo": 5, "descricao": "cafe", "categoria": 1, "sync": 0, "lastupdate": "2016-04-11 10:53:55" }, { "codigo": 4, "descricao": "filipes", "categoria": 1, "sync": 1, "lastupdate": "2016-04-11 10:53:55" }, { "codigo": 6, "descricao": "testes", "categoria": 1, "sync": 1, "lastupdate": "2016-04-11 10:53:55" } ],


ZSAPI 132 / 144


"lastupdate": "2016-09-28 17:03:23" } ] (...)




category SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:








ZSAPI 133 / 144




category SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Cada instância Family dentro do Array deve obedecer à seguinte estrutura:

category [codigo] SIM integer Número/código da categoria.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "category":[


}

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias são retornadas na Resposta no atributo “category” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




Nota: Só podem ser removidos instâncias da Entidade Modelo que não estejam associados a transações e que não tenham subfamílias associadas a transações.


ZSAPI 134 / 144



Argumentos:


category [lastupdate] SIM datetime Timestamp de verificação.


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “category”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “category” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "category": [ { "codigo": 914, "descricao": "Sem Categoria", "loja": 1, "subcategories": "", "lastupdate": "2016-10-07 09:41:16" } (...)



ZSAPI 135 / 144




Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância (vazia) do tipo <Entidade Modelo> no atributo “category”.





category[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “category”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:



ZSAPI 136 / 144


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “category” do tipo Array - consultar documento sobre estrutura da entidade.



@TODO

Interface::Cards Interface responsável por processar todos os Requests relativos às instâncias dos cartões Entidades modelo: Cards



card [codigo] SIM integer Número/código da Cartão.


ZSAPI 137 / 144



{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "card":{ "codigo":2} }

Respostas:


StatusCode::ZSAPI_OK (200) A instância é retornada na Resposta no atributo “card” do tipo <Entidade Modelo> - consultar documento sobre estrutura da entidade.






StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “card” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "card": [ { "loja": 1, "numero": 4, "cliente": 6, "saldo": -9.01,


ZSAPI 138 / 144


"estado": 0, "motivo": "aaaa ddddd ccccc", "data": "2016-04-11", "prepago": 1, "minimo": 0, "mingrupo": 0, "maximo": 0, "maxgrupo": 0, "zona": 0, "serie": 0, "perfil": 0, "creditos": 0, "gravacao": "", "maxcredito": 12, "lastupdate": "2016-04-11 10:05:11" }, { "loja": 1, "numero": 5, "cliente": 7, "saldo": 0, "estado": 0, "motivo": "", "data": "1899-12-30", "prepago": 3, "minimo": 0, "mingrupo": 0, "maximo": 0, "maxgrupo": 0, "zona": 0, "serie": 0, "perfil": 0, "creditos": 0, "gravacao": "", "maxcredito": 0, "lastupdate": "2016-03-03 09:35:34" }, (...)




ZSAPI 139 / 144



card SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.

Respostas:









card SIM json Array Um Array de JSON Object do tipo <Entidade Modelo>.



ZSAPI 140 / 144


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", "card":[

{"numero":11}, {"numero":12}

] }

Respostas:


StatusCode::ZSAPI_OK (200) Todas as instâncias foram removidas com sucesso. Todas as instâncias são retornadas na Resposta no atributo “card” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.





Argumentos:


card [lastupdate] SIM datetime Timestamp de verificação.



ZSAPI 141 / 144


{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “card”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “card” do tipo Array <Entidade Modelo> - consultar documento sobre estrutura da entidade.




(...) "card": [ { "loja": 1, "numero": 1019, "cliente": 0, "saldo": 0, "estado": 0, "motivo": "stuff", "data": "1899-12-30", "prepago": 1, "minimo": 0, "mingrupo": 0, "maximo": 0, "maxgrupo": 0, "zona": 0, "serie": 0, "perfil": 0, "creditos": 0, "gravacao": "", "maxcredito": 0, "lastupdate": "2017-01-30 14:56:22" } (...)



ZSAPI 142 / 144




Respostas:


StatusCode::ZSAPI_OK (200) Na Resposta é retornada uma instância (vazia) do tipo <Entidade Modelo> no atributo “card”.





ZSAPI 143 / 144



card[lastupdate] SIM datetime Timestamp de verificação. Exemplo de um Request JSON:

{ "auth_hash":"289c35ba199c582b04f8c8db415cd54876fd0d0f", “card”:{”lastupdate”: “2012-01-01 00:00:00”}

}

Respostas:


StatusCode::ZSAPI_OK (200) As instâncias são retornadas na Resposta no atributo “card” do tipo Array - consultar documento sobre estrutura da entidade.




ZSAPI 144 / 144


Manual de Integração ZSAPI Versão: 1.8 Draft 2 Março, 2017

Documents

Transcript of Manual de Integração ZSAPI Versão: 1.8 Draft 2 Março, 2017