Criar Filial
Conceituação#
Neste método você pode cadastrar uma filial
Método#
Para registrar a filial, usaremos o método: /api/v3/branches
POST https://api.kigisistemas.com.br/mobiage-api/api/v3/branches
Neste método usaremos as Headers:
| KEY | VALUE |
|---|---|
| Content-Type | application/json |
| gumgaToken | Seu Token |
Atributos#
Opcionais#
Request Params#
POST https://api.kigisistemas.com.br/mobiage-api/api/v3/branches
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| thirdId | string | id da empresa |
| registerName | string | Nome de registro da empresa |
| socialName | string | Nome social da empresa |
| shortName | string | Nome abreviado da empresa |
| federalDocument | string | CNPJ da empresa sem pontuação |
| stateDocument | string | Inscrição estadual da empresa sem pontuação |
| stateIndicator | string | Indicador da Inscrição estadual |
| telephones | string[] | Lista de telefones |
| emails | string[] | Lista de e-mails |
| adresses | Address[] | Lista de endereços |
| active | boolean | Indica se o cadastro está ativo |
| urlPhoto | string | URL de uma foto da empresa |
| registrationDate | Date | Data de criação do cadastro |
| dateOfFoundation | Date | Data de fundação da empresa |
| modality | Modality | Modalidade da empresa |
| isFranchisee | Boolean | Identifica se é um franqueado |
| isFranchisor | Boolean | Identifica se é um franqueador |
| isMatrix | Boolean | Identifica se é uma matriz |
| userId | String | ID do usuário responsável pela criação da empresa |
Address {array}#
| Atributo | Tipo | Descrição |
|---|---|---|
| zipCode | string | CEP sem pontuação |
| premisse | string | Localização. Exemplo: Avenida Paulista |
| number | string | Número da localização |
| information | string | Complemento do endereço |
| neighbourhood | string | Bairro do endereço |
| localization | string | Cidade |
| state | string | Estado. Exemplo: SP, PR, SC, ES, etc. |
| country | string | País. Exemplo: Brasil |
| formalCode | string | código IBGE da cidade |
| stateCode | string | código do estado |
| isPrimary | string | identifica se o endereço é o principal ou não |
stateIndicator#
| Tipo | Descrição |
|---|---|
| string | opções: CONTRIBUINTE ou ISENTO ou NAO_CONTRIBUINTE |
Modality#
| Tipo | Descrição |
|---|---|
| string | opções: RETAIL-[Varejo] ou WHOLESALE=[Atacado] |
Exemplo