TOTVS Automação Fiscal

Árvore de páginas

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: EsocialLotation

Objetivo: Disponibilizar os cadastros de lotações do TAF eSocial através de webservice REST.

Descrição: Retorna os cadastros de lotações 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 lotações 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/EsocialLotation/v1?companyId=1


ParâmetroDescriçãoObrigatório
companyIdIdentificador da empresa*


  • companyId– Código identificador da empresa.
Estrutura da Resposta do método GET (Response):


Atributo

Pai

Nivel

Ocorrência

Formato

lotations

-

1

1

-

branchId

1

2

1

String

companyId121String

id

1

2

1

String

lotationCode

1

2

1

String

description

1

2

1

String

internalId121String


  • 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/EsocialLotation/v1?companyId=1



Response:
{
    "lotations": [
        {
            "branchId": "D MG 01 ",
            "lotationCode": "000001                        ",
            "companyId": "T1",
            "internalId": "000001                        ",
            "id": "000001",
            "description": "                                                                                                                                                                                                                            "
        },
        {
            "branchId": "D MG 01 ",
            "lotationCode": "000002                        ",
            "companyId": "T1",
            "internalId": "000002                        ",
            "id": "000002",
            "description": "                                                                                                                                                                                                                            "
        }
    ]
}



*Será liberado juntamente com o pacote de atualização e-Social 2.4.