Linha RM

Atalhos

Páginas filhas
  • FISCAL01-13177 DT API RM Cadastro de Filiais
  • Criado por Usuário desconhecido (paulo.rocha), última alteração em 27 jul, 2020


01. DADOS GERAIS

Produto:

TOTVS Backoffice

Linha de Produto:

Linha RM

Segmento:

Backoffice

Módulo:Gestão Fiscal
Função:Api Cadastrod e Filiais


02. SITUAÇÃO/REQUISITO

Para possibilitarmos a integração do Backoffice RM com o Master CRM, precisamos implementar a API do Cadastro de Filial (dados globais).

Para isso devemos seguir o contrato abaixo:

https://api.totvs.com.br/apidetails/Branch_v1_000.json   

03. SOLUÇÃO


Implementação da API de Filiais conforme orientação: https://api.totvs.com.br/apidetails/Branch_v1_000.json

Implementação REST: GET, POST, PATCH, PUT

URL Exemplo: http://localhost:8051/api/fiscal/v1/branches/

Obs: Quando executado o método GET ALL o registros sempre virão ordenados por Código da Coligada e Código da Filial.


Mapeamento dos Campos

APIRMObservação
BranchInternalIdGFILIAL.CODCOLIGADA | GFILIAL.CODFILIALcampo calculado
CompanyCodeGFILIAL.CODCOLIGADA
DescriptionGFILIAL.NOME
CodeGFILIAL.CODFILIAL
TitleGFILIAL.NOMEFANTASIA
CGCGFILIAL.CGC
StateRegistrationGFILIAL.INSCRICAOESTADUAL
DDDGFILIAL.DDD
PhoneGFILIAL.TELEFONE
StreetGFILIAL.RUA
ComplementGFILIAL.COMPLEMENTO
NeighborhoodGFILIAL.BAIRRO
StateGFILIAL.ESTADO
CityGMUNICIPIONOMEMUNICIPIO
ZipCodeGFILIAL.CEP
CityCodeGFILIAL.CODMUNICIPIO
CNAECodeGFILIAL.CODATIVFED
NIREGFILIAL.NUMREGJUNTA
DTREGFILIAL.DATAREGJUNTA
SuframaGFILIAL.SUFRAMA


Exemplo JSON:


{
"CompanyCode": 8,
"Code": 3,
"Title": "Filial 3 Fantasia",
"CGC": "64.667.260/0001-06",
"Description": "Filial 3 Nome",
"StateRegistration": "853/5905845",
"DDD": "31",
"Phone": "35952912",
"Street": "Siqueira Campos",
"Complement": "Complemento 123",
"Neighborhood": "Centro",
"State": "RS",
"ZipCode": "90010-907",
"CityCode": "14902",
"CNAECode": "12345",
"NIRE": "30121970",
"DTRE": "2020-01-01T00:00:00",
"Suframa": "1544787",
"City": "Porto Alegre",
"BranchInternalId": "8|3"
}