Histórico da Página
RESTWeb Service REST
Produto: | TOTVS Automação Fiscal |
Versões: | 12.1.17+ |
Este documento tem o objetivo de fornecer informações para utilização do Web Service REST de integração com o TOTVS Automação Fiscal.
Para mais detalhes sobre o conceito de um serviços REST clique aqui.
Para mais detalhes sobre serviços REST na arquitetura Protheus clique aqui.
Índice
|
---|
Definição do Serviço
Nome: EsocialEstablishment
Objetivo: Disponibilizar os cadastros de estabelecimentos do TAF eSocial através de webservice REST.
Descrição: Retorna os cadastros de estabelecimentos de acordo com os parâmetros enviados, através de webservice REST.
Métodos: GET.
Definição dos métodos
GET
Descrição do Método: O método GET retorna os registros do cadastro de estabelecimentos de acordo com os parâmetros (atributos) enviados na URL.
A Consulta pode combinar parâmetros utilizando a sintaxe “Query String” conforme exemplo abaixo:
http://localhost:17115/rest/EsocialEstablishment/v1?companyId=T1&branch=D MG 01
Parâmetro | Descrição | Obrigatório |
---|---|---|
companyId | Identificador da empresa | * |
branch | Identificador da filial | * |
- companyId– Código identificador da empresa.
- branch– Código identificador da filial.
Estrutura da Resposta do método GET (Response):
Atributo | Pai | Nivel | Ocorrência | Formato |
---|---|---|---|---|
lotationsestablishments | - | 1 | 1 | - |
branchIdregistrationNumber | 1 | 2 | 1 | String |
companyIdregistrationType | 1 | 2 | 1 | String |
id | 1 | 2 | 1 | String |
lotationCode | 1 | 2 | 1 | String |
description | 1 | 2 | 1 | String |
internalId | 1 | 2 | 1 | String |
- registrationNumber– Número da inscrição do estabelecimento.
- registrationType– Tipo do estabelecimento
- branchId– Identificador da filial.
- companyId– Identificador da empresa.
- id– Id da lotação.
- lotationCode– Código da lotação.
- description– Descrição da lotação.
- internalId– Id interno da lotação.
Exemplos de requisição utilizando o método GET:
Request:
http://localhost:17115/rest/EsocialEstablishment/v1?companyId=T1&branch=D MG 01
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "establishments": [ { "registrationNumber": "68416327000182 ", "registrationType": "1" }, { "registrationNumber": "98599322000101 ", "registrationType": "1" } ] } |
...