Objetivo

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

Pré-Requisitos e Restrições

Integração


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

Os dados integrados são: 

SECTIONS                            |         PCFILIAL

API

Referência Winthor

id

PCFILIAL.CODIGO

corporateName

PCFILIAL.RAZAOSOCIAL

aliasName

PCFILIAL.FANTASIA

corporateIdentificationNumber

PCFILIAL.CGC

stateRegistration

PCFILIAL.IE

municipalRegistration

PCFILIAL.IM

address

PCFILIAL.ENDERECO

addressNumber

PCFILIAL.NUMERO

addressComplement

PCFILIAL.COMPLEMENTOENDERECO

district

PCFILIAL.BAIRRO

city

PCFILIAL.CIDADE

state

PCESTADO.ESTADO

federativeUnit

PCESTADO.UF

codStateIbge

PCESTADO.CODIBGE

codCityIbge

PCFILIAL.CODMUN

zipCode

PCFILIAL.CEP

phoneNumber

PCFILIAL.TELEFONE

exclusion

PCFILIAL.DTEXCLUSAO

optingSimplesNacionalPCFILIAL.OPTANTESIMPLESNAC
createdAtPCFILIAL.DTCADASTRO
lastChangePCFILIAL.DTULTALTER

Exemplo do envio da requisição:

method: 'GET',
url: '/api/branch/v1/'
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:  

{
    "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"
        }
    ],
    "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": []
}