Pular para o conteúdo
notemnotemDocumentação

Referência da API › Empresas

Cadastrar empresa

Cadastra uma empresa que vai emitir notas pela notem.

POST/api/v1/empresas

É o primeiro passo para emitir. Informe o CNPJ, a razão social, o endereço e o código IBGE do município; o nome do município e a UF são preenchidos pela notem.

A empresa vale para os dois ambientes. Uma alteração feita com a chave de homologação também aparece em produção.

Depois do cadastro, grave a configuração fiscal, envie o certificado digital e cadastre ao menos um serviço. Consultar situação mostra o que ainda falta. Se o CNPJ já estiver cadastrado na organização, a resposta é 409 com o ID da empresa existente.

Parâmetros

Idempotency-Keytextono cabeçalho
Chave de idempotência (até 100 caracteres) aceita em POST, PATCH, PUT e DELETE; vale 24 h por integração e ambiente, exceto emissão, cancelamento, análise e substituição de notas (associação duradoura ao pedido). Mesmo conteúdo devolve a mesma resposta (cabeçalho Idempotent-Replayed true); conteúdo diferente devolve 409 IDEMPOTENCIA_CONFLITO. Obrigatória em emissão, cancelamento e substituição. · até 100 caracteres

Corpo da requisição

id_externotexto ou null
Único por organização · até 100 caracteres
cnpjtextoobrigatório
CNPJ de 14 posições, numérico ou alfanumérico (12 posições 0-9/A-Z + 2 dígitos verificadores). Na entrada, máscara e minúsculas são aceitas e normalizadas; nas respostas vem sempre com 14 caracteres maiúsculos, sem máscara. · até 18 caracteres
razao_socialtextoobrigatório
nome_fantasiatexto ou null
inscricao_municipaltexto ou null
emailtexto ou null
telefonetexto
Formato: ^\d{0,15}$
ativabooleano
Padrão: true
enderecoobjetoobrigatório
endereco.ceptextoobrigatório
Formato: ^\d{8}$
endereco.logradourotextoobrigatório
endereco.numerotextoobrigatório
endereco.complementotexto ou null
endereco.bairrotextoobrigatório
endereco.codigo_municipiotextoobrigatório
Formato: ^\d{7}$

Respostas

201 Empresa criada

Campos da resposta
idtexto
UUID
id_externotexto ou null
até 100 caracteres
cnpjtexto
CNPJ de 14 posições, numérico ou alfanumérico (12 posições 0-9/A-Z + 2 dígitos verificadores). Na entrada, máscara e minúsculas são aceitas e normalizadas; nas respostas vem sempre com 14 caracteres maiúsculos, sem máscara. · até 18 caracteres
razao_socialtexto
nome_fantasiatexto ou null
inscricao_municipaltexto ou null
emailtexto ou null
telefonetexto ou null
enderecoobjeto
endereco.ceptexto ou null
endereco.logradourotexto ou null
endereco.numerotexto ou null
endereco.complementotexto ou null
endereco.bairrotexto ou null
endereco.codigo_municipiotexto
Formato: ^\d{7}$
endereco.municipiotexto ou null
endereco.uftexto ou null
ativabooleano
criada_emtexto
data e hora ISO 8601
atualizada_emtexto
data e hora ISO 8601

400 Erro no formato padrão

401 Chave ausente, inválida ou revogada

409 EMPRESA_DUPLICADA (detalhes traz o id existente), ID_EXTERNO_DUPLICADO ou IDEMPOTENCIA_CONFLITO

Limites

Valem também os limites gerais da chave. Veja Limites de uso.