TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • APIs Integrações - Filiais

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração com filiais.

Pré-Requisitos e Restrições

  • Necessário instalar o serviço winthor-filial(Versão 202501.36 ou superior) na rotina 801 do WTA, conforme indicação Parametrizações WTA.

Integração


A integração consiste em retornar todas as filiais cadastradas na rotina 535

Os dados integrados são: 

Table Filter Plugin license is not active, please generate a trial license or purchase the product.


SECTIONS                            |         PCFILIAL


API

Referência Winthor

Referência da imagem abaixo 

id

PCFILIAL.CODIGO

1

corporateName

PCFILIAL.RAZAOSOCIAL

4

aliasName

PCFILIAL.FANTASIA

5

corporateIdentificationNumber

PCFILIAL.CGC

2

stateRegistration

PCFILIAL.IE

3

municipalRegistration

PCFILIAL.IM

--

address

PCFILIAL.ENDERECO

7

addressNumber

PCFILIAL.NUMERO

9

addressComplement

PCFILIAL.COMPLEMENTOENDERECO

12

district

PCFILIAL.BAIRRO

8

city

PCFILIAL.CIDADE

--

state

PCESTADO.ESTADO

13

federativeUnit

PCESTADO.UF

10

codStateIbge

PCESTADO.CODIBGE


codCityIbge

PCFILIAL.CODMUN

12

zipCode

PCFILIAL.CEP

11

phoneNumber

PCFILIAL.TELEFONE

6

exclusion

PCFILIAL.DTEXCLUSAO

--

optingSimplesNacionalPCFILIAL.OPTANTESIMPLESNAC--
createdAtPCFILIAL.DTCADASTRO--
lastChangePCFILIAL.DTULTALTER--
creditLimitPaymentMethodParâmetro da 132: UTILIZALIMCREDCOB--



Exemplo do envio da requisição:

URI
method: 'GET',
url: '/api/branch/v1/'
Params
id			: 1						- código da filial
page		: 1						- número da página
pageSize	: 10					- quantidade por página
lastChange  : AAAA-MM-DDTHH:MM:SS   - data de ultima alteração



Exemplo JSON da resposta:  

Response
{
    "first": false,
    "items": [
        {
            "id": "1",
            "corporateName": "Totvs Tecnologia",
            "aliasName": "TOTVS",
            "corporateIdentificationNumber": "00000000000000",
            "stateRegistration": "0000000",
            "address": "RUA xpto",
            "addressNumber": 0,
            "district": "",
            "city": "",
            "state": "",
            "federativeUnit": "",
            "codStateIbge": ,
            "codCityIbge": ,
            "zipCode": "",
            "phoneNumber": "",
            "createdAt": "2022-04-25T09:12:04",
            "lastChange": "2022-04-25T09:12:04",
            "creditLimitPaymentMethod": boolean
        }
    ],
    "hasNext": false
}

Caso obtenha o conteúdo abaixo ao enviar a requisição, verifique na rotina 812 do WTA se o serviço winthor-filial está instalado. Caso não esteja, acesse a rotina 801 do WTA e realize a instalação conforme indicação na documentação APIs Integrações - Filiais  

<html>
 
<head>
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
    <title>Error 404 Not Found</title>
</head>
 
<body>
    <h2>HTTP ERROR 404</h2>
    <p>Problem accessing /api/branch/v1/. Reason:
        <pre>    Not Found</pre>
    </p>
    <hr><a href="http://eclipse.org/jetty">Powered by Jetty:// 9.3.21.v20170918</a>
    <hr />
 
</body>
 
</html>

Caso apresente 403 Forbidden, verifique se realizou a autenticação antes do envio da requisição.

{
    "mensagem": "O Usuário não está autorizado a utilizar esse recurso",
    "erros": []
}  




  • Sem rótulos