Histórico da Página
Esta entidade exibe informações sobre as filiais da empresa e suporta as seguintes operações: GET, POST e PUT.
Esta api é importante para o Sistema pois definirá em quais filiais nossos serviços poderão ser executados, isto é, este cadastro define a lista de valores suportados pelo parâmetro de header tenantId. Filiais inativadas não permitirão a utilização da nossa api.
Campos do retorno
Nome | Descrição | Tamanho do campo | Tipo | Mais detalhes |
Id | Id da filial | 2 | Caracter | O código da filial deve conter exatamente dois caracteres e só deve ser informado no POST |
branchName | Razão social | 100 | Caracter | - |
tradingName | Nome fantasia | 100 | Caracter | - |
Address | Endereço | 100 | Caracter | O endereço deve ser informado no padrão “logradouro, número, complemento”. O complemento não é obrigatório |
neighborhood | Bairro | 100 | Caracter |
|
city | Município | 100 | Caracter |
|
state | UF do estado | 2 | Caracter | O valor deve estar presente em /first/api/v1/state |
zipCode | CEP | 9 | Caracter |
|
phone | Número de telefone da filial | 14 | Caracter |
|
fax | Número do fax da filial | 14 | Caracter |
|
Email da filial | 60 | Caracter |
| |
cnpj | CNPJ da filial | 14 | Caracter |
|
stateInscriptionType | Tipo de inscrição estadual | 1 | Numérico | ?? |
stateInscription | Inscrição estadual | 14 | Caracter |
|
ibgeCityCode | Código IBGE do município | 7 | Caracter | O valor deve estar presente em /first/api/v1/city |
municipalInscription | Inscrição municipal | 14 | Caracter |
|
nire | NIRE da filial | 10 | Caracter |
|
nireDate | Data do NIRE da filial | - |
|
|
CNAE | Número CNAE da filial | 10 | Caracter |
|
active | Se a filial está ativa ou não | 1 | Caracter | 1 – Ativa 2 - Inativa |