Card |
---|
| Requisição Section |
---|
Column |
---|
| Exemplo de body da requisição[ { "bairro": "string", "cep": "string", "cidade": "string", "cnpj": "string", "codigoIdentificacaoLoja": "string", "codigoMaster": "string", "codigoMunicipioIbge": "string", "codigoOrganizacional": "string", "codigoUFIBGE": "string", "complemento": "string", "endereco": "string", "estado": "string", "idDominioManutencao": "string", "idInquilino": "string", "idProprietario": "string", "idRetaguarda": "string", "idRetaguardaRede": "string", "inscricaoEstadual": "string", "inscricaoMunicipal": "string", "loteOrigem": "string", "modeloFiscal": 0, "nomeFantasia": "string", "nomeMaster": "string", "numero": "string", "numeroLoja": "string", "razaoSocial": "string", "rede": "string", "regimeTributario": 0, "siglaUf": "string", "situacao": 1, "telefone": "string" } ]
|
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|
---|
loteOrigem | string | Código do lote | Sim |
|
| idInquilino | string | Identificador do inquilino | Sim |
|
| idRetaguarda | string | Identificador da loja na retaguarda | Sim | Tamanho máximo: 100 caracteres |
| idProprietario | string | Identificador do proprietário. (Adicionando na criação do compartilhamento) | Sim |
|
| razaoSocial | string | Razão social da loja | Sim | Tamanho máximo (50) |
| nomeFantasia | string | Nome Fantasia da loja | Sim | Tamanho máximo (50) |
| cnpj | string | CNPJ da loja | Sim | Tamanho máximo (14) |
| inscricaoEstadual | string | Inscrição estadual da loja | Sim | Tamanho máximo (15) Tamanho mínimo (2) |
| endereco | string | Endereço da loja | Sim | Tamanho máximo (200) Tamanho mínimo (2) |
| numero | string | Número do local da loja | Não | Tamanho máximo (10) |
| bairro | string | Bairro da loja | Sim | Tamanho máximo (150) Tamanho mínimo (2) |
| cidade | sring | Cidade da loja | Sim | Tamanho máximo (150) Tamanho mínimo (2) |
| estado | string | Estado da loja | Sim | Tamanho máximo (50) |
| siglaUf | string | Sigla do estado da loja | Sim | Tamanho máximo (2) Tamanho mínimo (2) |
| CodigoUFIBGE | string | Código do estado | Sim | Tamanho igual (2) |
| CodigoMunicipioIbge | string | Código do município | Sim | Tamanho igual (50) |
| cep | string | Cep da lona | Sim | Tamanho máximo (8) |
| complemento | string | Complemente do endereço da loja | Não | Tamanho máximo (100) Tamanho mínimo (2) |
| modeloFiscal | Enum | Modelo fiscal utilizado (Tipos abaixo) | Não |
| Enviar um dos tipos abaixo. Caso não tenha definido o valor deste campo, informar "null" ou não enviar esse campo na requisição | regimeTributario | int | Regime tributário utilizado (Tipos abaixo) | Sim |
|
| rede | string | Rede da loja | Sim | Tamanho máximo (40) |
| numeroLoja | string | Numero da loja | Sim | Tamanho máximo (30) |
| telefone | string | Telefone da loja | Não
|
| Informar somente os números | inscricaoMunicipal | string | Inscrição municipal da loja | Não | Tamanho máximo (15) |
| codigoIdentificacaoLoja | string | Código de identificação da loja | Sim | Tamanho máximo (20) |
| situacao | int | Situação da loja | Sim | (0 - inativo, 1 ativo) |
| idRetaguardaRede | string | Identificador da rede naretaguarda | Não | Tamanho máximo (100) |
| codigoMaster | string | Código master | Não | Tamanho máximo (50) |
| nomeMaster | string | Nome master | Não | Tamanho máximo (50) |
| idDominioManutencao | string | Identificador dominio manutenção | Não |
|
| codigoOrganizacional | string | Codigo Organizacional | Não |
|
|
|
Expandir |
---|
title | Tipos de Regime Tributário |
---|
| Código | Nome |
---|
0 | SimplesNacional | 1 | RegimeNormal |
|
Expandir |
---|
title | Tipos de Modelo fiscal |
---|
| Código | Nome |
---|
0 | NaoConfigurado | 1 | SAT | 2 | NFCe | 3 | MFE |
|
|
Retorno Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, "message": "", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
|
Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
Card |
---|
| Informações |
---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição Section |
---|
Column |
---|
| Exemplo de body da requisição[ { "bairro": "string", "cep": "string", "cidade": "string", "cnpj": "string", "codigoIdentificacaoLoja": "string", "codigoMaster": "string", "codigoMunicipioIbge": "string", "codigoOrganizacional": "string", "codigoUFIBGE": "string", "complemento": "string", "endereco": "string", "estado": "string", "idDominioManutencao": "string", "idInquilino": "string", "idProprietario": "string", "idRetaguarda": "string", "idRetaguardaRede": "string", "inscricaoEstadual": "string", "inscricaoMunicipal": "string", "loteOrigem": "string", "modeloFiscal": 0, "nomeFantasia": "string", "nomeMaster": "string", "numero": "string", "numeroLoja": "string", "razaoSocial": "string", "rede": "string", "regimeTributario": 0, "siglaUf": "string", "situacao": 1, "telefone": "string" } ] |
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|
---|
loteOrigem | string | Código do lote | Sim |
|
| idInquilino | string | Identificador do inquilino | Sim |
|
| idRetaguarda | string | Identificador da loja na retaguarda | Sim | Tamanho máximo: 100 caracteres |
| idProprietario | string | Identificador do proprietário. (Adicionando na criação do compartilhamento) | Sim |
|
| razaoSocial | string | Razão social da loja | Sim | Tamanho máximo (50) |
| nomeFantasia | string | Nome Fantasia da loja | Sim | Tamanho máximo (50) |
| cnpj | string | CNPJ da loja | Sim | Tamanho máximo (14) |
| inscricaoEstadual | string | Inscrição estadual da loja | Sim | Tamanho máximo (15) Tamanho mínimo (2) |
| endereco | string | Endereço da loja | Sim | Tamanho máximo (200) Tamanho mínimo (2) |
| numero | string | Número do local da loja | Não | Tamanho máximo (10) |
| bairro | string | Bairro da loja | Sim | Tamanho máximo (150) Tamanho mínimo (2) |
| cidade | sring | Cidade da loja | Sim | Tamanho máximo (150) Tamanho mínimo (2) |
| estado | string | Estado da loja | Sim | Tamanho máximo (50) |
| siglaUf | string | Sigla do estado da loja | Sim | Tamanho máximo (2) Tamanho mínimo (2) |
| CodigoUFIBGE | string | Código do estado | Sim | Tamanho igual (2) |
| CodigoMunicipioIbge | string | Código do município | Sim | Tamanho igual (50) |
| cep | string | Cep da lona | Sim | Tamanho máximo (8) |
| complemento | string | Complemente do endereço da loja | Não | Tamanho máximo (100) Tamanho mínimo (2) |
| modeloFiscal | Enum | Modelo fiscal utilizado (Tipos abaixo) | Não |
| Enviar um dos tipos abaixo. Caso não tenha definido o valor deste campo, informar "null" ou não enviar esse campo na requisição | regimeTributario | int | Regime tributário utilizado (Tipos abaixo) | Sim |
|
| rede | string | Rede da loja | Sim | Tamanho máximo (40) |
| numeroLoja | string | Numero da loja | Sim | Tamanho máximo (30) |
| telefone | string | Telefone da loja | Não
|
| Informar somente os números | inscricaoMunicipal | string | Inscrição municipal da loja | Não | Tamanho máximo (15) |
| codigoIdentificacaoLoja | string | Código de identificação da loja | Sim | Tamanho máximo (20) |
| situacao | int | Situação da loja (Tipos abaixo) | Sim |
|
| idRetaguardaRede | string | Identificador da rede naretaguarda | Não | Tamanho máximo (100) |
| codigoMaster | string | Código master | Não | Tamanho máximo (50) |
| nomeMaster | string | Nome master | Não | Tamanho máximo (50) |
| idDominioManutencao | string | Identificador dominio manutenção | Não |
|
| codigoOrganizacional | string | Codigo Organizacional | Não |
|
|
|
|
Retornos Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
|
Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|