Linha RM

Atalhos

Páginas filhas
  • API (Filiais)

CONTEÚDO

  1. Visão Geral

Possibilitar a integração do Cadastro de Filiais RM via API (rest)

Para isso devemos seguir o contrato abaixo:

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

  1. Tabela utilizada

GFILIAL

01. VISÃO GERAL

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

Obs:

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

O método DELETE não foi implementado por questão de regras Segurança.


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
CityGMUNICIPIO.NOMEMUNICIPIO
ZipCodeGFILIAL.CEP
CityCodeGFILIAL.CODMUNICIPIO
CNAECodeGFILIAL.CODATIVFED
NIREGFILIAL.NUMREGJUNTA
DTREGFILIAL.DATAREGJUNTA
SuframaGFILIAL.SUFRAMA


02. EXEMPLO DE UTILIZAÇÃO

URL Exemplo: http://localhost:8051/api/framework/v1/Branches/


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"
}


Exemplo de utilização com Postman: