Documentação de sandbox (homologação)v3.1.18

No momento, a mesma versão de produção.

ACBr API (3.1.18)

Download OpenAPI specification:OpenAPI 3 (JSON)

🔎 Procurando um campo específico (ex.: vBC, tribMun, nDPS)? A busca acima encontra apenas operações. Para localizar um campo dentro dos schemas, use o Buscador de campos.

API para automação comercial e documentos fiscais.

Autenticação Esta API usa OAuth 2.0 no fluxo client_credentials.

Ambientes disponíveis

Produção: https://prod.acbr.api.br
Homologação: https://hom.acbr.api.br
Autenticação para ambos os ambientes: https://auth.acbr.api.br/realms/ACBrAPI/protocol/openid-connect/token

Endpoint para obter o token

POST https://auth.acbr.api.br/realms/ACBrAPI/protocol/openid-connect/token

Content-Type

application/x-www-form-urlencoded

Parâmetros do corpo

grant_type=client_credentials
client_id=SEU_CLIENT_ID
client_secret=SEU_CLIENT_SECRET
scope=empresa nfe nfse

Exemplo de corpo

grant_type=client_credentials&client_id=SEU_CLIENT_ID&client_secret=SEU_CLIENT_SECRET&scope=empresa%20nfe

Uso do token nas requisições

Authorization: Bearer SEU_ACCESS_TOKEN

Conta

Consultar o extrato de movimentação de créditos do tenant atual.

Authorizations:

oauth2

query Parameters

data_inicial	string
data_final	string
top	integer
skip	integer
limit	integer
client_id	string
incluir_isentos	boolean

Responses

Response Schema: application/json

@count	integer
	Array of objects (ContaExtratoCredito)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"tenant_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"quota_name": "string",
"movement_type": "string",
"credits": 0,
"document_id": "string",
"arquivo_id": "string",
"http_method": "string",
"uri": "string",
"client_id": "string",
"origin": "string",
"resource_type": "string",
"resource_id": "string",
"request_id": "string"
}
]
}

Consultar o limite de uso e o consumo de uma cota específica.

Authorizations:

oauth2

path Parameters

nome

required

string

Nome da cota a ser consultada.

Responses

Response Schema: application/json

nome	string
consumo	number
limite	number or null
disponivel	number
ultima_atualizacao	string

Response samples

Content type

application/json

{"nome": "string",
"consumo": 0,
"limite": 0,
"disponivel": 0,
"ultima_atualizacao": "string"
}

Consultar o resumo da cota de créditos pré-pagos.

Authorizations:

oauth2

Responses

Response Schema: application/json

percentual_disponivel	number
creditos_disponiveis	number
ultima_atualizacao	string

Response samples

Content type

application/json

{"percentual_disponivel": 0,
"creditos_disponiveis": 0,
"ultima_atualizacao": "string"
}

Consultar os limites de uso e consumo das cotas disponíveis, exceto a cota de créditos pré-pagos. Deprecated

Authorizations:

oauth2

Responses

Response Schema: application/json

@count	integer
	Array of objects (ContaCota)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"nome": "string",
"consumo": 0,
"limite": 0,
"disponivel": 0,
"ultima_atualizacao": "string"
}
]
}

Empresa

Cadastre e administre todas as empresas vinculadas à sua conta.

Alterar configuração de CT-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor Individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor Individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Alterar configuração de CT-e OS

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor Individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor Individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Alterar configuração de DC-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

ambiente

required

string

Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

ambiente

required

string

Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"ambiente": "homologacao"
}

Alterar configuração de Distribuição de NF-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

distribuicao_automatica	boolean or null Default: false Indica se a distribuição automática está habilitada. Quando ativada, a API realizará automaticamente pedidos de distribuição de notas fiscais eletrônicas (NF-e) utilizando o último NSU. A frequência dessas distribuições é controlada pelo campo `distribuicao_intervalo_horas`, cujo valor padrão é 24 horas (uma vez ao dia).
distribuicao_intervalo_horas	integer or null [ 1 .. 24 ] Default: 24 Define o intervalo mínimo, em horas, entre distribuições automáticas de documentos. Esse valor determina com que frequência a API executará novas requisições automáticas de distribuição de notas fiscais eletrônicas (NF-e). Deve ser um valor entre 1 e 24. Por exemplo, se configurado como 4, uma nova tentativa de distribuição só será feita se pelo menos 4 horas tiverem se passado desde a última requisição. Esse campo só é relevante quando `distribuicao_automatica` estiver habilitado.
ciencia_automatica	boolean or null Default: false Indica se a manifestação de Ciência da Operação (210210) deve ser feita automaticamente pela API. Caso habilitada, a manifestação de ciência será realizada para notas recebidas por qualquer forma de consulta ou modo de distribuição (manual ou automático).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

distribuicao_automatica	boolean or null Default: false Indica se a distribuição automática está habilitada. Quando ativada, a API realizará automaticamente pedidos de distribuição de notas fiscais eletrônicas (NF-e) utilizando o último NSU. A frequência dessas distribuições é controlada pelo campo `distribuicao_intervalo_horas`, cujo valor padrão é 24 horas (uma vez ao dia).
distribuicao_intervalo_horas	integer or null [ 1 .. 24 ] Default: 24 Define o intervalo mínimo, em horas, entre distribuições automáticas de documentos. Esse valor determina com que frequência a API executará novas requisições automáticas de distribuição de notas fiscais eletrônicas (NF-e). Deve ser um valor entre 1 e 24. Por exemplo, se configurado como 4, uma nova tentativa de distribuição só será feita se pelo menos 4 horas tiverem se passado desde a última requisição. Esse campo só é relevante quando `distribuicao_automatica` estiver habilitado.
ciencia_automatica	boolean or null Default: false Indica se a manifestação de Ciência da Operação (210210) deve ser feita automaticamente pela API. Caso habilitada, a manifestação de ciência será realizada para notas recebidas por qualquer forma de consulta ou modo de distribuição (manual ou automático).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"distribuicao_automatica": false,
"distribuicao_intervalo_horas": 24,
"ciencia_automatica": false,
"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"distribuicao_automatica": false,
"distribuicao_intervalo_horas": 24,
"ciencia_automatica": false,
"ambiente": "homologacao"
}

Alterar configuração de MDF-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

ambiente

required

string

Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

ambiente

required

string

Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"ambiente": "homologacao"
}

Alterar configuração de NF-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Alterar configuração de NFC-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor individual (MEI).
required	object (EmpresaConfigNfceSefaz) Configurações do CSC (Código de Segurança do Contribuinte) para emissão da NFC-e. Se informado `id_csc` e `csc`, será utilizada a versão 2 do QR Code da NFC-e. Para utilizar a versão 3 do QR Code (NT 2025.001), que dispensa o CSC, envie `id_csc` igual a 0 (zero) e `csc` como string vazia. Observação: emitente pessoa física (CPF) utilizar sempre a versão 3 do QR Code.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor individual (MEI).
required	object (EmpresaConfigNfceSefaz) Configurações do CSC (Código de Segurança do Contribuinte) para emissão da NFC-e. Se informado `id_csc` e `csc`, será utilizada a versão 2 do QR Code da NFC-e. Para utilizar a versão 3 do QR Code (NT 2025.001), que dispensa o CSC, envie `id_csc` igual a 0 (zero) e `csc` como string vazia. Observação: emitente pessoa física (CPF) utilizar sempre a versão 3 do QR Code.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"CRT": 3,
"sefaz": {"id_csc": 0,
"csc": "string"
},
"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"CRT": 3,
"sefaz": {"id_csc": 0,
"csc": "string"
},
"ambiente": "homologacao"
}

Alterar configuração de NFCom

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Alterar configuração de NFS-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

	object (EmpresaConfigNfseRegTrib) Grupo de informações relativas aos regimes de tributação do prestador de serviços.
	object (EmpresaConfigRps) Configuração de numeração de lote, série e RPS.
	object (EmpresaConfigPrefeitura) Dados adicionais para comunicação com a prefeitura. Essa validação é dinâmica, de acordo com a necessidade de cada município.
numeracao_automatica	boolean Default: true Indicador para que a API controle a numeração da NFSe.
incentivo_fiscal	boolean Default: false Indicador se a empresa possui algum tipo de incentivo fiscal.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Responses

Response Schema: application/json

	object (EmpresaConfigNfseRegTrib) Grupo de informações relativas aos regimes de tributação do prestador de serviços.
	object (EmpresaConfigRps) Configuração de numeração de lote, série e RPS.
	object (EmpresaConfigPrefeitura) Dados adicionais para comunicação com a prefeitura. Essa validação é dinâmica, de acordo com a necessidade de cada município.
numeracao_automatica	boolean Default: true Indicador para que a API controle a numeração da NFSe.
incentivo_fiscal	boolean Default: false Indicador se a empresa possui algum tipo de incentivo fiscal.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Request samples

Payload

Content type

application/json

{"regTrib": {"opSimpNac": 1,
"regApTribSN": 0,
"regEspTrib": 0
},
"rps": {"lote": 0,
"serie": "string",
"numero": 0
},
"prefeitura": {"login": "string",
"senha": "string",
"token": "string"
},
"numeracao_automatica": true,
"incentivo_fiscal": false,
"ambiente": "homologacao"
}

Response samples

Content type

application/json

{"regTrib": {"opSimpNac": 1,
"regApTribSN": 0,
"regEspTrib": 0
},
"rps": {"lote": 0,
"serie": "string",
"numero": 0
},
"prefeitura": {"login": "string",
"senha": "string",
"token": "string"
},
"numeracao_automatica": true,
"incentivo_fiscal": false,
"ambiente": "homologacao"
}

Alterar empresa

Altera o cadastro de uma empresa (emitente/prestador) que esteja associada a sua conta. Nesse método, por tratar-se de um PUT, caso algum campo não seja informado, o valor dele será apagado.

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

cpf_cnpj required	string CPF ou CNPJ da empresa. Utilize o valor sem máscara.
created_at	string <date-time> Data/hora em que o objeto foi criado na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
updated_at	string <date-time> Data e hora que o objeto foi alterado pela última vez na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
inscricao_estadual	string <= 50 characters Inscrição estadual da empresa.
inscricao_municipal	string <= 50 characters Inscrição municipal da empresa.
nome_razao_social required	string <= 500 characters Razão social da empresa.
nome_fantasia	string <= 500 characters Nome fantasia da empresa.
fone	string Telefone da empresa.
email required	string Email da empresa.
required	object (EmpresaEndereco) Endereço da empresa.

Responses

Response Schema: application/json

cpf_cnpj required	string CPF ou CNPJ da empresa. Utilize o valor sem máscara.
created_at	string <date-time> Data/hora em que o objeto foi criado na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
updated_at	string <date-time> Data e hora que o objeto foi alterado pela última vez na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
inscricao_estadual	string <= 50 characters Inscrição estadual da empresa.
inscricao_municipal	string <= 50 characters Inscrição municipal da empresa.
nome_razao_social required	string <= 500 characters Razão social da empresa.
nome_fantasia	string <= 500 characters Nome fantasia da empresa.
fone	string Telefone da empresa.
email required	string Email da empresa.
required	object (EmpresaEndereco) Endereço da empresa.

Request samples

Payload

Content type

application/json

{"cpf_cnpj": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"inscricao_estadual": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
}
}

Response samples

Content type

application/json

{"cpf_cnpj": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"inscricao_estadual": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
}
}

Baixar logotipo

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: /

string <binary>

Cadastrar certificado

Cadastre ou atualize um certificado digital e vincule a sua empresa, para que possa iniciar a emissão de notas.

No parâmetro certificado, envie o binário do certificado digital (.pfx ou .p12) codificado em base64.

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: application/json
required

certificado required	string <byte> Binário do certificado digital (.pfx ou .p12) codificado em base64.
password required	string Senha do certificado.

Responses

Response Schema: application/json

id	string
created_at	string <date-time>
serial_number	string
issuer_name	string
not_valid_before	string <date-time>
not_valid_after	string <date-time>
thumbprint	string
subject_name	string
cpf_cnpj	string
nome_razao_social	string

Request samples

Payload

Content type

application/json

{"certificado": "string",
"password": "string"
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"serial_number": "string",
"issuer_name": "string",
"not_valid_before": "2019-08-24T14:15:22Z",
"not_valid_after": "2019-08-24T14:15:22Z",
"thumbprint": "string",
"subject_name": "string",
"cpf_cnpj": "string",
"nome_razao_social": "string"
}

Cadastrar empresa

Cadastre uma nova empresa (emitente ou prestador) à sua conta.

Authorizations:

oauth2

Request Body schema: application/json
required

cpf_cnpj required	string CPF ou CNPJ da empresa. Utilize o valor sem máscara.
created_at	string <date-time> Data/hora em que o objeto foi criado na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
updated_at	string <date-time> Data e hora que o objeto foi alterado pela última vez na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
inscricao_estadual	string <= 50 characters Inscrição estadual da empresa.
inscricao_municipal	string <= 50 characters Inscrição municipal da empresa.
nome_razao_social required	string <= 500 characters Razão social da empresa.
nome_fantasia	string <= 500 characters Nome fantasia da empresa.
fone	string Telefone da empresa.
email required	string Email da empresa.
required	object (EmpresaEndereco) Endereço da empresa.

Responses

Response Schema: application/json

cpf_cnpj required	string CPF ou CNPJ da empresa. Utilize o valor sem máscara.
created_at	string <date-time> Data/hora em que o objeto foi criado na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
updated_at	string <date-time> Data e hora que o objeto foi alterado pela última vez na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
inscricao_estadual	string <= 50 characters Inscrição estadual da empresa.
inscricao_municipal	string <= 50 characters Inscrição municipal da empresa.
nome_razao_social required	string <= 500 characters Razão social da empresa.
nome_fantasia	string <= 500 characters Nome fantasia da empresa.
fone	string Telefone da empresa.
email required	string Email da empresa.
required	object (EmpresaEndereco) Endereço da empresa.

Request samples

Payload

Content type

application/json

{"cpf_cnpj": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"inscricao_estadual": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
}
}

Response samples

Content type

application/json

{"cpf_cnpj": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"inscricao_estadual": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
}
}

Consultar certificado

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

id	string
created_at	string <date-time>
serial_number	string
issuer_name	string
not_valid_before	string <date-time>
not_valid_after	string <date-time>
thumbprint	string
subject_name	string
cpf_cnpj	string
nome_razao_social	string

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"serial_number": "string",
"issuer_name": "string",
"not_valid_before": "2019-08-24T14:15:22Z",
"not_valid_after": "2019-08-24T14:15:22Z",
"thumbprint": "string",
"subject_name": "string",
"cpf_cnpj": "string",
"nome_razao_social": "string"
}

Consultar configuração de CT-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor Individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Consultar configuração de CT-e OS

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor Individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Consultar configuração de DC-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

ambiente

required

string

Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"ambiente": "homologacao"
}

Consultar configuração de Distribuição de NF-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

distribuicao_automatica	boolean or null Default: false Indica se a distribuição automática está habilitada. Quando ativada, a API realizará automaticamente pedidos de distribuição de notas fiscais eletrônicas (NF-e) utilizando o último NSU. A frequência dessas distribuições é controlada pelo campo `distribuicao_intervalo_horas`, cujo valor padrão é 24 horas (uma vez ao dia).
distribuicao_intervalo_horas	integer or null [ 1 .. 24 ] Default: 24 Define o intervalo mínimo, em horas, entre distribuições automáticas de documentos. Esse valor determina com que frequência a API executará novas requisições automáticas de distribuição de notas fiscais eletrônicas (NF-e). Deve ser um valor entre 1 e 24. Por exemplo, se configurado como 4, uma nova tentativa de distribuição só será feita se pelo menos 4 horas tiverem se passado desde a última requisição. Esse campo só é relevante quando `distribuicao_automatica` estiver habilitado.
ciencia_automatica	boolean or null Default: false Indica se a manifestação de Ciência da Operação (210210) deve ser feita automaticamente pela API. Caso habilitada, a manifestação de ciência será realizada para notas recebidas por qualquer forma de consulta ou modo de distribuição (manual ou automático).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"distribuicao_automatica": false,
"distribuicao_intervalo_horas": 24,
"ciencia_automatica": false,
"ambiente": "homologacao"
}

Consultar configuração de MDF-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

ambiente

required

string

Enum: "homologacao" "producao"

Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"ambiente": "homologacao"
}

Consultar configuração de NF-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor individual (MEI).
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Consultar configuração de NFC-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal; 4 - Simples Nacional - Microempreendedor individual (MEI).
required	object (EmpresaConfigNfceSefaz) Configurações do CSC (Código de Segurança do Contribuinte) para emissão da NFC-e. Se informado `id_csc` e `csc`, será utilizada a versão 2 do QR Code da NFC-e. Para utilizar a versão 3 do QR Code (NT 2025.001), que dispensa o CSC, envie `id_csc` igual a 0 (zero) e `csc` como string vazia. Observação: emitente pessoa física (CPF) utilizar sempre a versão 3 do QR Code.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"CRT": 3,
"sefaz": {"id_csc": 0,
"csc": "string"
},
"ambiente": "homologacao"
}

Consultar configuração de NFCom

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

CRT	integer Default: 3 Código de Regime Tributário. Este campo será preenchido com: 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita bruta; 3 – Regime Normal.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"CRT": 3,
"ambiente": "homologacao"
}

Consultar configuração de NFS-e

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

	object (EmpresaConfigNfseRegTrib) Grupo de informações relativas aos regimes de tributação do prestador de serviços.
	object (EmpresaConfigRps) Configuração de numeração de lote, série e RPS.
	object (EmpresaConfigPrefeitura) Dados adicionais para comunicação com a prefeitura. Essa validação é dinâmica, de acordo com a necessidade de cada município.
numeracao_automatica	boolean Default: true Indicador para que a API controle a numeração da NFSe.
incentivo_fiscal	boolean Default: false Indicador se a empresa possui algum tipo de incentivo fiscal.
ambiente required	string Enum: "homologacao" "producao" Indica se a empresa irá emitir em produção ou homologação.

Response samples

Content type

application/json

{"regTrib": {"opSimpNac": 1,
"regApTribSN": 0,
"regEspTrib": 0
},
"rps": {"lote": 0,
"serie": "string",
"numero": 0
},
"prefeitura": {"login": "string",
"senha": "string",
"token": "string"
},
"numeracao_automatica": true,
"incentivo_fiscal": false,
"ambiente": "homologacao"
}

Consultar empresa

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Response Schema: application/json

cpf_cnpj required	string CPF ou CNPJ da empresa. Utilize o valor sem máscara.
created_at	string <date-time> Data/hora em que o objeto foi criado na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
updated_at	string <date-time> Data e hora que o objeto foi alterado pela última vez na API. Representado no formato `ISO 8601`. A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado.
inscricao_estadual	string <= 50 characters Inscrição estadual da empresa.
inscricao_municipal	string <= 50 characters Inscrição municipal da empresa.
nome_razao_social required	string <= 500 characters Razão social da empresa.
nome_fantasia	string <= 500 characters Nome fantasia da empresa.
fone	string Telefone da empresa.
email required	string Email da empresa.
required	object (EmpresaEndereco) Endereço da empresa.

Response samples

Content type

application/json

{"cpf_cnpj": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"inscricao_estadual": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
}
}

Deletar certificado

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Deletar empresa

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Deletar logotipo

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Responses

Enviar logotipo

Cadastre ou atualize um logotipo e vincule a sua empresa.

Restrições:

Tipos de mídia (MIME) suportados: image/png e image/jpeg
Tamanho máximo do arquivo: 200 KB

Cenários de uso:

Quero que minhas notas sejam impressas com esse logotipo.
Quero trocar o logotipo utilizado em minhas impressões.

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: multipart/form-data

Input

string <binary>

Responses

Listar certificados

Retorna a lista dos certificados associadas à sua conta. Os certificados são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
expires_in	integer > 0 Filtrar certificados que expiram dentro de X dias. Informe um número inteiro correspondente à quantidade de dias até o vencimento. Exemplos: expires_in=30 -> certificados que vencem nos próximos 30 dias. expires_in=7 -> certificados que vencem nos próximos 7 dias.
include_expired	boolean Default: true Indicar se os certificados já vencidos devem ser incluídos no resultado. Valores aceitos: `true`: incluir certificados vencidos. `false`: exibir apenas certificados válidos.

Responses

Response Schema: application/json

@count	integer
	Array of objects (EmpresaCertificado)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"serial_number": "string",
"issuer_name": "string",
"not_valid_before": "2019-08-24T14:15:22Z",
"not_valid_after": "2019-08-24T14:15:22Z",
"thumbprint": "string",
"subject_name": "string",
"cpf_cnpj": "string",
"nome_razao_social": "string"
}
]
}

Listar empresas

Retorna a lista das empresas associadas à sua conta. As empresas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj	string Filtrar pelo CPF ou CNPJ da empresa. Utilize o valor sem máscara.
nome_razao_social	string Filtrar pelo nome ou razão social da empresa. Esse filtro realiza uma correspondência pelo início do texto, retornando apenas empresas cujo nome ou razão social começam com o valor informado. Caso o filtro pelo CPF ou CNPJ também seja informado na requisição, este filtro é ignorado.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Empresa)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"cpf_cnpj": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"inscricao_estadual": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
}
}
]
}

Upload de certificado

Cadastre ou atualize um certificado digital e vincule a sua empresa, para que possa iniciar a emissão de notas.

Utilize o content-type igual a multipart/form-data.
No parâmetro file, envie o binário do arquivo (.pfx ou .p12) do certificado digital.
No parâmetro password, envie a senha do certificado.

Authorizations:

oauth2

path Parameters

cpf_cnpj

required

string

CPF ou CNPJ da empresa. Utilize o valor sem máscara.

Request Body schema: multipart/form-data

Input

string <binary>

Responses

Response Schema: application/json

id	string
created_at	string <date-time>
serial_number	string
issuer_name	string
not_valid_before	string <date-time>
not_valid_after	string <date-time>
thumbprint	string
subject_name	string
cpf_cnpj	string
nome_razao_social	string

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"serial_number": "string",
"issuer_name": "string",
"not_valid_before": "2019-08-24T14:15:22Z",
"not_valid_after": "2019-08-24T14:15:22Z",
"thumbprint": "string",
"subject_name": "string",
"cpf_cnpj": "string",
"nome_razao_social": "string"
}

CT-e

Conhecimento de Transporte Eletrônico.

Baixar PDF da carta de correção

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do cancelamento

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do DACTE

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

query Parameters

logotipo

boolean

Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

Responses

Response Schema: /

string <binary>

Baixar PDF do evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da carta de correção

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do CT-e

Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que o conhecimento tenha sido rejeitado.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da CT-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do CT-e processado

Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz cteProc).

O XML só estará disponível nesse endpoint caso o conhecimento tenha sido autorizado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /cte/{id}/xml/conhecimento.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do evento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do Protocolo da SEFAZ

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da CT-e gerado pela API.

Responses

Response Schema: /

string <binary>

Cancelar um CT-e autorizado

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Request Body schema: application/json

justificativa

string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"justificativa": "string"
}

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF/CNPJ do emitente. Utilize o valor sem máscara.
autorizador	string Ambiente Autorizador. Autorizadores disponíveis: `MT`, `MS`, `MG`, `PR`, `RS`, `SP`, `SVRS`, `SVSP`, `AN`. Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response Schema: application/json

autorizador	string Enum: "AM" "BA" "CE" "GO" "MG" "MS" "MT" "PE" "PR" "RS" "SP" "SVAN" "SVRS" "SVCAN" "SVCRS" "AN" "SVSP" "SVCSP" SEFAZ autorizadora responsável.
ambiente	string Enum: "homologacao" "producao" Identificação do Ambiente.
data_hora_consulta	string <date-time> Data e hora da consulta.
codigo_status	integer Código do status da mensagem enviada.
motivo_status	string Descrição literal do status do serviço solicitado.
tempo_medio_resposta	integer or null Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.
data_hora_retorno	string or null <date-time> Data e hora prevista para o retorno dos serviços prestados.

Response samples

Content type

application/json

{"autorizador": "AM",
"ambiente": "homologacao",
"data_hora_consulta": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"tempo_medio_resposta": 0,
"data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar a solicitação de correção do CT-e

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: application/json

required	Array of objects (CteInfCorrecao) non-empty Grupo de Informações de Correção.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"correcoes": [{"grupo_alterado": "string",
"campo_alterado": "string",
"valor_alterado": "string",
"numero_item_alterado": 0
}
],
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar CT-e

Consulta os detalhes de um CT-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de CT-e e a API irá retornar as informações do CT-e correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Consultar evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar o cancelamento do CT-e

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Emitir CT-e

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (CteSefazInfCte) Informações do CT-e.
	object (CteSefazInfCTeSupl) Informações suplementares do CT-e.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infCte": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cCT": "string",
"CFOP": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nCT": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"tpCTe": 0,
"procEmi": 0,
"verProc": "string",
"indGlobalizado": 0,
"cMunEnv": "string",
"xMunEnv": "string",
"UFEnv": "string",
"modal": "string",
"tpServ": 0,
"cMunIni": "string",
"xMunIni": "string",
"UFIni": "string",
"cMunFim": "string",
"xMunFim": "string",
"UFFim": "string",
"retira": 0,
"xDetRetira": "string",
"indIEToma": 0,
"toma3": {"toma": 0
},
"toma4": {"toma": 0,
"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"xFant": "string",
"fone": "string",
"enderToma": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string"
},
"email": "string"
},
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"tpPagAnt": 0,
"gPagAntecipado": {"chCTePagAnt": "string"
}
},
"compl": {"xCaracAd": "string",
"xCaracSer": "string",
"xEmi": "string",
"fluxo": {"xOrig": "string",
"pass": [{"xPass": null
}
],
"xDest": "string",
"xRota": "string"
},
"Entrega": {"semData": {"tpPer": 0
},
"comData": {"tpPer": 0,
"dProg": "2019-08-24"
},
"noPeriodo": {"tpPer": 0,
"dIni": "2019-08-24",
"dFim": "2019-08-24"
},
"semHora": {"tpHor": 0
},
"comHora": {"tpHor": 0,
"hProg": "string"
},
"noInter": {"tpHor": 0,
"hIni": "string",
"hFim": "string"
}
},
"origCalc": "string",
"destCalc": "string",
"xObs": "string",
"ObsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"ObsFisco": [{"xCampo": "string",
"xTexto": "string"
}
]
},
"emit": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"IEST": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"fone": "string"
},
"CRT": 0,
"ISUFEmit": "stringst"
},
"rem": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"xFant": "string",
"fone": "string",
"enderReme": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string"
},
"email": "string"
},
"exped": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"fone": "string",
"enderExped": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string"
},
"email": "string"
},
"receb": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"fone": "string",
"enderReceb": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string"
},
"email": "string"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"fone": "string",
"ISUF": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string"
},
"email": "string"
},
"vPrest": {"vTPrest": 0,
"vRec": 0,
"Comp": [{"xNome": "string",
"vComp": 0
}
]
},
"imp": {"ICMS": {"ICMS00": {"CST": "string",
"vBC": 0,
"pICMS": 0,
"vICMS": 0
},
"ICMS20": {"CST": "string",
"pRedBC": 1,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS45": {"CST": "string",
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS60": {"CST": "string",
"vBCSTRet": 0,
"vICMSSTRet": 0,
"pICMSSTRet": 0,
"vCred": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS90": {"CST": "string",
"pRedBC": 1,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"vCred": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMSOutraUF": {"CST": "string",
"pRedBCOutraUF": 1,
"vBCOutraUF": 0,
"pICMSOutraUF": 0,
"vICMSOutraUF": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMSSN": {"CST": "string",
"indSN": 0
}
},
"vTotTrib": 0,
"infAdFisco": "string",
"ICMSUFFim": {"vBCUFFim": 0,
"pFCPUFFim": 0,
"pICMSUFFim": 0,
"pICMSInter": 0,
"vFCPUFFim": 0,
"vICMSUFFim": 0,
"vICMSUFIni": 0
},
"IBSCBS": {"CST": "string",
"cClassTrib": "string",
"indDoacao": 0,
"gIBSCBS": {"vBC": 0,
"gIBSUF": {"pIBSUF": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"vIBSUF": null
},
"gIBSMun": {"pIBSMun": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"vIBSMun": null
},
"vIBS": 0,
"gCBS": {"pCBS": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"gALCZFMCBS": null,
"vCBS": null
},
"gTribRegular": {"CSTReg": null,
"cClassTribReg": null,
"pAliqEfetRegIBSUF": null,
"vTribRegIBSUF": null,
"pAliqEfetRegIBSMun": null,
"vTribRegIBSMun": null,
"pAliqEfetRegCBS": null,
"vTribRegCBS": null
},
"gTribCompraGov": {"pAliqIBSUF": null,
"vTribIBSUF": null,
"pAliqIBSMun": null,
"vTribIBSMun": null,
"pAliqCBS": null,
"vTribCBS": null
}
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vTotDFe": 0
},
"pgtoVinc": {"pgto": [{"nPag": "string",
"idTransacao": "string",
"tpMeioPgto": "string",
"CNPJReceb": "string",
"CNPJBasePSP": "string"
}
]
},
"infCTeNorm": {"infCarga": {"vCarga": 0,
"proPred": "string",
"xOutCat": "string",
"infQ": [{"cUnid": null,
"tpMed": null,
"qCarga": null
}
],
"vCargaAverb": 1
},
"infDoc": {"infNF": [{"nRoma": null,
"nPed": null,
"mod": null,
"serie": null,
"nDoc": null,
"dEmi": null,
"vBC": null,
"vICMS": null,
"vBCST": null,
"vST": null,
"vProd": null,
"vNF": null,
"nCFOP": null,
"nPeso": null,
"PIN": null,
"dPrev": null,
"infUnidCarga": [ ],
"infUnidTransp": [ ]
}
],
"infNFe": [{"chave": null,
"PIN": null,
"dPrev": null,
"infUnidCarga": [ ],
"infUnidTransp": [ ]
}
],
"infOutros": [{"tpDoc": null,
"descOutros": null,
"nDoc": null,
"dEmi": null,
"vDocFisc": null,
"dPrev": null,
"infUnidCarga": [ ],
"infUnidTransp": [ ]
}
],
"infDCe": [{"chave": null
}
]
},
"docAnt": {"emiDocAnt": [{"CNPJ": null,
"CPF": null,
"IE": null,
"UF": null,
"xNome": null,
"idDocAnt": [ ]
}
]
},
"infModal": {"versaoModal": "string",
"rodo": {"RNTRC": "string",
"occ": [null
]
},
"aereo": {"nMinu": 0,
"nOCA": "string",
"dPrevAereo": "2019-08-24",
"natCarga": {"xDime": null,
"cInfManu": [ ]
},
"tarifa": {"CL": null,
"cTar": null,
"vTar": null
},
"peri": [null
]
},
"ferrov": {"tpTraf": 0,
"trafMut": {"respFat": null,
"ferrEmi": null,
"vFrete": null,
"chCTeFerroOrigem": null,
"ferroEnv": [ ]
},
"fluxo": "string"
},
"aquav": {"vPrest": 0,
"vAFRMM": 0,
"xNavio": "string",
"balsa": [null
],
"nViag": "string",
"direc": "string",
"irin": "string",
"detCont": [null
],
"tpNav": 0
},
"duto": {"vTar": 1,
"dIni": "2019-08-24",
"dFim": "2019-08-24",
"classDuto": 0,
"tpContratacao": 0,
"codPontoEntrada": "string",
"codPontoSaida": "string",
"nContrato": "string"
},
"multimodal": {"COTM": "string",
"indNegociavel": 0,
"seg": {"infSeg": null,
"nApol": null,
"nAver": null
}
}
},
"veicNovos": [{"chassi": "string",
"cCor": "stri",
"xCor": "string",
"cMod": "string",
"vUnit": 0,
"vFrete": 0
}
],
"cobr": {"fat": {"nFat": "string",
"vOrig": 1,
"vDesc": 1,
"vLiq": 1
},
"dup": [{"nDup": null,
"dVenc": null,
"vDup": null
}
]
},
"infCteSub": {"chCte": "string",
"indAlteraToma": 0
},
"infGlobalizado": {"xObs": "stringstringstr"
},
"infServVinc": {"infCTeMultimodal": [{"chCTeMultimodal": null
}
]
}
},
"infCteComp": [{"chCTe": "string"
}
],
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
}
},
"infCTeSupl": {"qrCodCTe": "stringstringstringstringstringstringstringstringst"
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Emitir CT-e Simplificado

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (CteSimpSefazInfCteSimp) Informações do CT-e.
	object (CteSimpSefazInfCTeSuplSimp) Informações suplementares do CT-e.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infCte": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cCT": "string",
"CFOP": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nCT": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"tpCTe": 0,
"procEmi": 0,
"verProc": "string",
"cMunEnv": "string",
"xMunEnv": "string",
"UFEnv": "string",
"modal": "string",
"tpServ": 0,
"UFIni": "string",
"UFFim": "string",
"retira": 0,
"xDetRetira": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"tpPagAnt": 0,
"gPagAntecipado": {"chDFePagAnt": "string"
}
},
"compl": {"xCaracAd": "string",
"xCaracSer": "string",
"fluxo": {"xOrig": "string",
"pass": [{"xPass": null
}
],
"xDest": "string",
"xRota": "string"
},
"xObs": "string",
"ObsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"ObsFisco": [{"xCampo": "string",
"xTexto": "string"
}
]
},
"emit": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"IEST": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"fone": "string"
},
"CRT": 0,
"ISUFEmit": "stringst"
},
"toma": {"toma": 0,
"indIEToma": 0,
"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"ISUF": "string",
"fone": "string",
"enderToma": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string"
},
"email": "string"
},
"infCarga": {"vCarga": 0,
"proPred": "string",
"xOutCat": "string",
"infQ": [{"cUnid": "string",
"tpMed": "st",
"qCarga": 0
}
],
"vCargaAverb": 1
},
"det": [{"nItem": 1,
"cMunIni": "string",
"xMunIni": "string",
"cMunFim": "string",
"xMunFim": "string",
"vPrest": 0,
"vRec": 0,
"Comp": [{"xNome": null,
"vComp": null
}
],
"infNFe": [{"chNFe": null,
"PIN": null,
"dPrev": null,
"infUnidCarga": [ ],
"infUnidTransp": [ ]
}
],
"infDocAnt": [{"chCTe": null,
"tpPrest": null,
"infNFeTranspParcial": [ ]
}
]
}
],
"infModal": {"versaoModal": "string",
"rodo": {"RNTRC": "string",
"occ": [{"serie": null,
"nOcc": null,
"dEmi": null,
"emiOcc": null
}
]
},
"aereo": {"nMinu": 0,
"nOCA": "string",
"dPrevAereo": "2019-08-24",
"natCarga": {"xDime": "string",
"cInfManu": [null
]
},
"tarifa": {"CL": "s",
"cTar": "stri",
"vTar": 0
},
"peri": [{"nONU": null,
"qTotEmb": null,
"infTotAP": null
}
]
},
"ferrov": {"tpTraf": 0,
"trafMut": {"respFat": 0,
"ferrEmi": 0,
"vFrete": 0,
"chCTeFerroOrigem": "string",
"ferroEnv": [null
]
},
"fluxo": "string"
},
"aquav": {"vPrest": 0,
"vAFRMM": 0,
"xNavio": "string",
"balsa": [{"xBalsa": null
}
],
"nViag": "string",
"direc": "string",
"irin": "string",
"detCont": [{"nCont": null,
"lacre": [ ],
"infDoc": null
}
],
"tpNav": 0
},
"duto": {"vTar": 1,
"dIni": "2019-08-24",
"dFim": "2019-08-24",
"classDuto": 0,
"tpContratacao": 0,
"codPontoEntrada": "string",
"codPontoSaida": "string",
"nContrato": "string"
},
"multimodal": {"COTM": "string",
"indNegociavel": 0,
"seg": {"infSeg": {"xSeg": null,
"CNPJ": null
},
"nApol": "string",
"nAver": "string"
}
}
},
"cobr": {"fat": {"nFat": "string",
"vOrig": 1,
"vDesc": 1,
"vLiq": 1
},
"dup": [{"nDup": "string",
"dVenc": "2019-08-24",
"vDup": 1
}
]
},
"infCteSub": {"chCte": "string",
"indAlteraToma": 0
},
"imp": {"ICMS": {"ICMS00": {"CST": "string",
"vBC": 0,
"pICMS": 0,
"vICMS": 0
},
"ICMS20": {"CST": "string",
"pRedBC": 1,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS45": {"CST": "string",
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS60": {"CST": "string",
"vBCSTRet": 0,
"vICMSSTRet": 0,
"pICMSSTRet": 0,
"vCred": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS90": {"CST": "string",
"pRedBC": 1,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"vCred": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMSOutraUF": {"CST": "string",
"pRedBCOutraUF": 1,
"vBCOutraUF": 0,
"pICMSOutraUF": 0,
"vICMSOutraUF": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMSSN": {"CST": "string",
"indSN": 0
}
},
"vTotTrib": 0,
"infAdFisco": "string",
"ICMSUFFim": {"vBCUFFim": 0,
"pFCPUFFim": 0,
"pICMSUFFim": 0,
"pICMSInter": 0,
"vFCPUFFim": 0,
"vICMSUFFim": 0,
"vICMSUFIni": 0
},
"IBSCBS": {"CST": "string",
"cClassTrib": "string",
"indDoacao": 0,
"gIBSCBS": {"vBC": 0,
"gIBSUF": {"pIBSUF": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"vIBSUF": null
},
"gIBSMun": {"pIBSMun": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"vIBSMun": null
},
"vIBS": 0,
"gCBS": {"pCBS": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"gALCZFMCBS": null,
"vCBS": null
},
"gTribRegular": {"CSTReg": null,
"cClassTribReg": null,
"pAliqEfetRegIBSUF": null,
"vTribRegIBSUF": null,
"pAliqEfetRegIBSMun": null,
"vTribRegIBSMun": null,
"pAliqEfetRegCBS": null,
"vTribRegCBS": null
},
"gTribCompraGov": {"pAliqIBSUF": null,
"vTribIBSUF": null,
"pAliqIBSMun": null,
"vTribIBSMun": null,
"pAliqCBS": null,
"vTribCBS": null
}
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
}
},
"pgtoVinc": {"pgto": [{"nPag": "string",
"idTransacao": "string",
"tpMeioPgto": "string",
"CNPJReceb": "string",
"CNPJBasePSP": "string"
}
]
},
"total": {"vTPrest": 0,
"vTRec": 0,
"vTotDFe": 0
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
}
},
"infCTeSupl": {"qrCodCTe": "stringstringstringstringstringstringstringstringst"
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Listar CT-e

Retorna a lista de CT-e de acordo com os critérios de busca utilizados. Os CT-e são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Dfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Sincroniza dados no CT-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da CT-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

Sincronizar um CT-e que se encontra com o status erro na API, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
Sincronizar um CT-e que se encontra com o status autorizadona API, mas está cancelado na SEFAZ.
Sincronizar todos os eventos de Cancelamento e Carta de Correção de um CT-e que porventura não tenham sido feitos a partir da API.

Informações adicionais:

Consumo: 1 unidade por evento sincronizado ou requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Responses

Response Schema: application/json

status	string Enum: "pendente" "sincronizado" "erro" Situação atual da sincronização.
codigo_status	integer Código da situação atual do DF-e.
motivo_status	string Descrição literal da situação atual do DF-e.
data_recebimento	string <date-time> Data e hora de processamento.
chave	string Chave de Acesso do DF-e consultado.

Response samples

Content type

application/json

{"status": "pendente",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"chave": "string"
}

Solicitar correção do CT-e

É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e gerado pela API.

Request Body schema: application/json
required

required

Array of objects (CteInfCorrecao) non-empty

Grupo de Informações de Correção.

Array (non-empty)

grupo_alterado required	string [ 1 .. 20 ] characters Indicar o grupo de informações que pertence o "campo_alterado". Ex: ide.
campo_alterado required	string [ 1 .. 20 ] characters Nome do campo modificado do CT-e Original.
valor_alterado required	string [ 1 .. 500 ] characters Valor correspondente à alteração.
numero_item_alterado	integer or null Preencher com o indice do item alterado caso a alteração ocorra em uma lista. OBS: O indice inicia sempre em 1.

Responses

Response Schema: application/json

required	Array of objects (CteInfCorrecao) non-empty Grupo de Informações de Correção.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"correcoes": [{"grupo_alterado": "string",
"campo_alterado": "string",
"valor_alterado": "string",
"numero_item_alterado": 0
}
]
}

Response samples

Content type

application/json

{"correcoes": [{"grupo_alterado": "string",
"campo_alterado": "string",
"valor_alterado": "string",
"numero_item_alterado": 0
}
],
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

CT-e OS

Conhecimento de Transporte Eletrônico - Outros serviços.

Baixar PDF da carta de correção

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do cancelamento

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do DACTE

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

query Parameters

logotipo

boolean

Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

Responses

Response Schema: /

string <binary>

Baixar PDF do evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da carta de correção

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do CT-e OS

Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que o conhecimento tenha sido rejeitado.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da CT-e OS gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do CT-e OS processado

Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz cteProc).

O XML só estará disponível nesse endpoint caso o conhecimento tenha sido autorizado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /cteos/{id}/xml/conhecimento.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do evento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do Protocolo da SEFAZ

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da CT-e OS gerado pela API.

Responses

Response Schema: /

string <binary>

Cancelar um CT-e OS autorizado

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Request Body schema: application/json

justificativa

string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"justificativa": "string"
}

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF/CNPJ do emitente. Utilize o valor sem máscara.
autorizador	string Ambiente Autorizador. Autorizadores disponíveis: `MT`, `MS`, `MG`, `PR`, `RS`, `SP`, `SVRS`, `SVSP`, `AN`. Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response Schema: application/json

autorizador	string Enum: "AM" "BA" "CE" "GO" "MG" "MS" "MT" "PE" "PR" "RS" "SP" "SVAN" "SVRS" "SVCAN" "SVCRS" "AN" "SVSP" "SVCSP" SEFAZ autorizadora responsável.
ambiente	string Enum: "homologacao" "producao" Identificação do Ambiente.
data_hora_consulta	string <date-time> Data e hora da consulta.
codigo_status	integer Código do status da mensagem enviada.
motivo_status	string Descrição literal do status do serviço solicitado.
tempo_medio_resposta	integer or null Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.
data_hora_retorno	string or null <date-time> Data e hora prevista para o retorno dos serviços prestados.

Response samples

Content type

application/json

{"autorizador": "AM",
"ambiente": "homologacao",
"data_hora_consulta": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"tempo_medio_resposta": 0,
"data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar a solicitação de correção do CT-e OS

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: application/json

required	Array of objects (CteOsInfCorrecao) non-empty Grupo de Informações de Correção.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"correcoes": [{"grupo_alterado": "string",
"campo_alterado": "string",
"valor_alterado": "string",
"numero_item_alterado": 0
}
],
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar CT-e OS

Consulta os detalhes de um CT-e OS já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de CT-e OS e a API irá retornar as informações do CT-e OS correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Consultar evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar o cancelamento do CT-e OS

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Emitir CT-e OS

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (CteOsSefazInfCteOS) Informações do CT-e Outros Serviços.
	object (CteOsSefazInfCTeSuplOS) Informações suplementares do CT-e.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infCte": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cCT": "string",
"CFOP": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nCT": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"tpCTe": 0,
"procEmi": 0,
"verProc": "string",
"cMunEnv": "string",
"xMunEnv": "string",
"UFEnv": "string",
"modal": "string",
"tpServ": 0,
"indIEToma": 0,
"cMunIni": "string",
"xMunIni": "string",
"UFIni": "string",
"cMunFim": "string",
"xMunFim": "string",
"UFFim": "string",
"infPercurso": [{"UFPer": "string"
}
],
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
}
},
"compl": {"xCaracAd": "string",
"xCaracSer": "string",
"xEmi": "string",
"xObs": "string",
"ObsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"ObsFisco": [{"xCampo": "string",
"xTexto": "string"
}
]
},
"emit": {"CNPJ": "string",
"IE": "string",
"IEST": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"fone": "string"
},
"CRT": 0,
"ISUFEmit": "stringst"
},
"toma": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"xFant": "string",
"fone": "string",
"enderToma": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string"
},
"email": "string"
},
"vPrest": {"vTPrest": 0,
"vRec": 0,
"Comp": [{"xNome": "string",
"vComp": 0
}
]
},
"imp": {"ICMS": {"ICMS00": {"CST": "string",
"vBC": 0,
"pICMS": 0,
"vICMS": 0
},
"ICMS20": {"CST": "string",
"pRedBC": 1,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS45": {"CST": "string",
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMS90": {"CST": "string",
"pRedBC": 1,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"vCred": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMSOutraUF": {"CST": "string",
"pRedBCOutraUF": 1,
"vBCOutraUF": 0,
"pICMSOutraUF": 0,
"vICMSOutraUF": 0,
"vICMSDeson": 0,
"cBenef": "string"
},
"ICMSSN": {"CST": "string",
"indSN": 0
}
},
"vTotTrib": 0,
"infAdFisco": "string",
"ICMSUFFim": {"vBCUFFim": 0,
"pFCPUFFim": 0,
"pICMSUFFim": 0,
"pICMSInter": 0,
"vFCPUFFim": 0,
"vICMSUFFim": 0,
"vICMSUFIni": 0
},
"infTribFed": {"vPIS": 0,
"vCOFINS": 0,
"vIR": 0,
"vINSS": 0,
"vCSLL": 0
},
"IBSCBS": {"CST": "string",
"cClassTrib": "string",
"indDoacao": 0,
"gIBSCBS": {"vBC": 0,
"gIBSUF": {"pIBSUF": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"vIBSUF": null
},
"gIBSMun": {"pIBSMun": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"vIBSMun": null
},
"vIBS": 0,
"gCBS": {"pCBS": null,
"gDif": null,
"gDevTrib": null,
"gRed": null,
"gALCZFMCBS": null,
"vCBS": null
},
"gTribRegular": {"CSTReg": null,
"cClassTribReg": null,
"pAliqEfetRegIBSUF": null,
"vTribRegIBSUF": null,
"pAliqEfetRegIBSMun": null,
"vTribRegIBSMun": null,
"pAliqEfetRegCBS": null,
"vTribRegCBS": null
},
"gTribCompraGov": {"pAliqIBSUF": null,
"vTribIBSUF": null,
"pAliqIBSMun": null,
"vTribIBSMun": null,
"pAliqCBS": null,
"vTribCBS": null
}
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vTotDFe": 0
},
"pgtoVinc": {"pgto": [{"nPag": "string",
"idTransacao": "string",
"tpMeioPgto": "string",
"CNPJReceb": "string",
"CNPJBasePSP": "string"
}
]
},
"infCTeNorm": {"infServico": {"xDescServ": "string",
"infQ": {"qCarga": 0
}
},
"infDocRef": [{"nDoc": "string",
"serie": "str",
"subserie": "str",
"dEmi": "2019-08-24",
"vDoc": 0,
"chBPe": "string"
}
],
"seg": [{"respSeg": 0,
"xSeg": "string",
"nApol": "string"
}
],
"infModal": {"versaoModal": "string",
"rodoOS": {"TAF": "string",
"NroRegEstadual": "string",
"veic": {"placa": null,
"RENAVAM": null,
"prop": null,
"UF": null
},
"infFretamento": {"tpFretamento": null,
"dhViagem": null
}
}
},
"infCteSub": {"chCte": "string"
},
"refCTeCanc": "string",
"cobr": {"fat": {"nFat": "string",
"vOrig": 1,
"vDesc": 1,
"vLiq": 1
},
"dup": [{"nDup": null,
"dVenc": null,
"vDup": null
}
]
},
"infGTVe": [{"chCTe": "string",
"Comp": [null
]
}
]
},
"infCteComp": [{"chCTe": "string"
}
],
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"tpPagAnt": 0,
"gPagAntecipado": {"chCTePagAnt": "string"
}
},
"infCTeSupl": {"qrCodCTe": "stringstringstringstringstringstringstringstringst"
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Listar CT-e OS

Retorna a lista de CT-e OS de acordo com os critérios de busca utilizados. Os CT-e OS são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Dfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Sincroniza dados no CT-e OS a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual do CT-e OS na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

Sincronizar um CT-e OS que se encontra com o status erro na API, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
Sincronizar um CT-e OS que se encontra com o status autorizadona API, mas está cancelado na SEFAZ.
Sincronizar todos os eventos de Cancelamento e Carta de Correção de um CT-e OS que porventura não tenham sido feitos a partir da API.

Informações adicionais:

Consumo: 1 unidade por evento sincronizado ou requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Responses

Response Schema: application/json

status	string Enum: "pendente" "sincronizado" "erro" Situação atual da sincronização.
codigo_status	integer Código da situação atual do DF-e.
motivo_status	string Descrição literal da situação atual do DF-e.
data_recebimento	string <date-time> Data e hora de processamento.
chave	string Chave de Acesso do DF-e consultado.

Response samples

Content type

application/json

{"status": "pendente",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"chave": "string"
}

Solicitar correção do CT-e OS

É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do CT-e OS gerado pela API.

Request Body schema: application/json
required

required

Array of objects (CteOsInfCorrecao) non-empty

Grupo de Informações de Correção.

Array (non-empty)

grupo_alterado required	string [ 1 .. 20 ] characters Indicar o grupo de informações que pertence o "campo_alterado". Ex: ide.
campo_alterado required	string [ 1 .. 20 ] characters Nome do campo modificado do CT-e OS Original.
valor_alterado required	string [ 1 .. 500 ] characters Valor correspondente à alteração.
numero_item_alterado	integer or null Preencher com o indice do item alterado caso a alteração ocorra em uma lista. OBS: O indice inicia sempre em 1.

Responses

Response Schema: application/json

required	Array of objects (CteOsInfCorrecao) non-empty Grupo de Informações de Correção.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"correcoes": [{"grupo_alterado": "string",
"campo_alterado": "string",
"valor_alterado": "string",
"numero_item_alterado": 0
}
]
}

Response samples

Content type

application/json

{"correcoes": [{"grupo_alterado": "string",
"campo_alterado": "string",
"valor_alterado": "string",
"numero_item_alterado": 0
}
],
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

DC-e

Declaração de Conteúdo Eletrônica.

Baixar PDF do DACE

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da DC-e

Utilize esse endpoint para obter o XML da DC-e enviada para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que a declaração tenha sido rejeitada.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerada pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da DC-e processada

Utilize esse endpoint para obter o XML da DC-e enviada para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz dceProc).

O XML só estará disponível nesse endpoint caso a DC-e tenha sido autorizada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /dce/{id}/xml/declaracao.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerada pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerada pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do Protocolo da SEFAZ

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerada pela API.

Responses

Response Schema: /

string <binary>

Cancelar uma DC-e autorizada

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerada pela API.

Request Body schema: application/json

justificativa

string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"justificativa": "string"
}

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ.

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF/CNPJ do emitente. Utilize o valor sem máscara.
autorizador	string Ambiente Autorizador. Autorizadores disponíveis: `AN`. Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response Schema: application/json

autorizador	string Enum: "AM" "BA" "CE" "GO" "MG" "MS" "MT" "PE" "PR" "RS" "SP" "SVAN" "SVRS" "SVCAN" "SVCRS" "AN" "SVSP" "SVCSP" SEFAZ autorizadora responsável.
ambiente	string Enum: "homologacao" "producao" Identificação do Ambiente.
data_hora_consulta	string <date-time> Data e hora da consulta.
codigo_status	integer Código do status da mensagem enviada.
motivo_status	string Descrição literal do status do serviço solicitado.
tempo_medio_resposta	integer or null Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.
data_hora_retorno	string or null <date-time> Data e hora prevista para o retorno dos serviços prestados.

Response samples

Content type

application/json

{"autorizador": "AM",
"ambiente": "homologacao",
"data_hora_consulta": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"tempo_medio_resposta": 0,
"data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar DC-e

Consulta os detalhes de uma DC-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de DC-e e a API irá retornar as informações da DC-e correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerada pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Consultar o cancelamento da DC-e

Authorizations:

oauth2

path Parameters

required

string

ID único da DC-e gerada pela API.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Emitir DC-e

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (DceSefazInfDCe) Informações da DCe.
required	object (DceSefazInfSolicDCe) Informações de solicitação da DCe pelo Fisco.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infDCe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cDC": "string",
"mod": 0,
"serie": 0,
"nDC": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"tpEmis": 0,
"tpEmit": 0,
"nSiteAutoriz": 0,
"cDV": 0,
"tpAmb": 0,
"verProc": "string"
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
}
},
"Fisco": {"CNPJ": "string",
"xOrgao": "string",
"UF": "string"
},
"Marketplace": {"CNPJ": "string",
"xNome": "string",
"Site": "string"
},
"Transportadora": {"CNPJ": "string",
"xNome": "string"
},
"ECT": {"CNPJ": "string",
"xNome": "string"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idOutros": "string",
"xNome": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string"
}
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"det": [{"nItem": 1,
"prod": {"xProd": "string",
"NCM": "string",
"qCom": 0,
"vUnCom": 0,
"vProd": 0
},
"infAdProd": "string"
}
],
"total": {"vDC": 0
},
"transp": {"modTrans": 0,
"CNPJTransp": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"infAdMarketplace": "string",
"infAdECT": "string",
"obsEmit": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsFisco": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsMarketplace": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsECT": [{"xCampo": "string",
"xTexto": "string"
}
]
},
"infDec": {"xObs1": "string",
"xObs2": "string"
}
},
"infSolicDCe": {"xSolic": "string"
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Listar DC-e

Retorna a lista de DC-e de acordo com os critérios de busca utilizados. As DC-e são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Dfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

MDF-e

Manifesto Eletrônico de Documentos Fiscais.

Baixar PDF do cancelamento

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do DAMDFE

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

query Parameters

logotipo

boolean

Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

Responses

Response Schema: /

string <binary>

Baixar PDF do encerramento

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do encerramento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do evento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do MDF-e

Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que o manifesto tenha sido rejeitado.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da MDF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do MDF-e processado

Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz mdfeProc).

O XML só estará disponível nesse endpoint caso o manifesto tenha sido autorizado ou denegado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /mdfe/{id}/xml/manifesto.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do Protocolo da SEFAZ

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da MDF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Cancelar um MDF-e autorizado

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Request Body schema: application/json

Dados do cancelamento.

justificativa

string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"justificativa": "string"
}

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF/CNPJ do emitente. Utilize o valor sem máscara.
autorizador	string Ambiente Autorizador. Autorizadores disponíveis: `SVRS`. Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response Schema: application/json

autorizador	string Enum: "AM" "BA" "CE" "GO" "MG" "MS" "MT" "PE" "PR" "RS" "SP" "SVAN" "SVRS" "SVCAN" "SVCRS" "AN" "SVSP" "SVCSP" SEFAZ autorizadora responsável.
ambiente	string Enum: "homologacao" "producao" Identificação do Ambiente.
data_hora_consulta	string <date-time> Data e hora da consulta.
codigo_status	integer Código do status da mensagem enviada.
motivo_status	string Descrição literal do status do serviço solicitado.
tempo_medio_resposta	integer or null Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.
data_hora_retorno	string or null <date-time> Data e hora prevista para o retorno dos serviços prestados.

Response samples

Content type

application/json

{"autorizador": "AM",
"ambiente": "homologacao",
"data_hora_consulta": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"tempo_medio_resposta": 0,
"data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consulta MDF-e não encerrados

Authorizations:

oauth2

query Parameters

cpf_cnpj

required

string

CPF/CNPJ do emitente. Utilize o valor sem máscara.

Responses

Response Schema: application/json

tpAmb	integer or null Identificação do Ambiente: 1 - Produção 2 - Homologação
verAplic	string or null Versão do Aplicativo que processou o MDF-e.
cStat required	integer or null Código do status da mensagem enviada.
xMotivo	string or null Descrição literal do status do serviço solicitado.
cUF	integer or null código da UF de atendimento.
	Array of objects (MdfeNaoEncerrado)

Response samples

Content type

application/json

{"tpAmb": 0,
"verAplic": "string",
"cStat": 0,
"xMotivo": "string",
"cUF": 0,
"infMDFe": [{"chMDFe": "string",
"nProt": "string"
}
]
}

Consultar encerramento do MDF-e

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: application/json

data_encerramento	string <date> Data que o manifesto foi encerrado.
uf	string UF de encerramento do manifesto.
codigo_municipio	string Código do Município de encerramento do manifesto.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"data_encerramento": "2019-08-24",
"uf": "string",
"codigo_municipio": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar evento do MDF-e

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar lote de MDF-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único do lote gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
created_at	string <date-time>
status	string Enum: "pendente" "processado" "erro"
ambiente	string Enum: "homologacao" "producao"
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote	string or null
	object (DfeRecibo)
	Array of objects (Dfe)

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Consultar manifesto

Consulta os detalhes de um manifesto já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de manifestos e a API irá retornar as informações do manifesto correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Consultar o cancelamento do MDF-e

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Emitir lote de MDF-e

Informações adicionais:

Consumo: 1 unidade por MDF-e.

Authorizations:

oauth2

Request Body schema: application/json
required

	Array of objects (MdfePedidoEmissao) = 1 items
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string <= 50 characters Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote required	string

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
created_at	string <date-time>
status	string Enum: "pendente" "processado" "erro"
ambiente	string Enum: "homologacao" "producao"
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote	string or null
	object (DfeRecibo)
	Array of objects (Dfe)

Request samples

Payload

Content type

application/json

{"documentos": [{"infMDFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"tpAmb": 0,
"tpEmit": 0,
"tpTransp": 0,
"mod": 0,
"serie": 0,
"nMDF": 1,
"cMDF": "string",
"cDV": 0,
"modal": 0,
"dhEmi": "2019-08-24T14:15:22Z",
"tpEmis": 0,
"procEmi": "string",
"verProc": "string",
"UFIni": "string",
"UFFim": "string",
"infMunCarrega": [null
],
"infPercurso": [null
],
"dhIniViagem": "2019-08-24T14:15:22Z",
"indCanalVerde": 0,
"indCarregaPosterior": 0
},
"emit": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": null,
"nro": null,
"xCpl": null,
"xBairro": null,
"cMun": null,
"xMun": null,
"CEP": null,
"UF": null,
"fone": null,
"email": null
}
},
"infModal": {"versaoModal": "string",
"aereo": {"nac": null,
"matr": null,
"nVoo": null,
"cAerEmb": null,
"cAerDes": null,
"dVoo": null
},
"rodo": {"infANTT": null,
"veicTracao": null,
"veicReboque": [ ],
"codAgPorto": null,
"lacRodo": [ ]
},
"aquav": {"irin": null,
"tpEmb": null,
"cEmbar": null,
"xEmbar": null,
"nViag": null,
"cPrtEmb": null,
"cPrtDest": null,
"prtTrans": null,
"tpNav": null,
"infTermCarreg": [ ],
"infTermDescarreg": [ ],
"infEmbComb": [ ],
"infUnidCargaVazia": [ ],
"infUnidTranspVazia": [ ],
"MMSI": null
},
"ferrov": {"trem": null,
"vag": [ ]
}
},
"infDoc": {"infMunDescarga": [null
]
},
"seg": [{"infResp": null,
"infSeg": null,
"nApol": null,
"nAver": [ ]
}
],
"prodPred": {"tpCarga": "string",
"xProd": "string",
"cEAN": "string",
"NCM": "string",
"infLotacao": {"infLocalCarrega": null,
"infLocalDescarrega": null
}
},
"tot": {"qCTe": 0,
"qNFe": 0,
"qMDFe": 0,
"vCarga": 0,
"cUnid": "string",
"qCarga": 0
},
"lacres": [{"nLacre": null
}
],
"autXML": [{"CNPJ": null,
"CPF": null
}
],
"infAdic": {"infAdFisco": "string",
"infCpl": "string"
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
}
},
"infMDFeSupl": {"qrCodMDFe": "stringstringstringstringstringstringstringstringst"
},
"ambiente": "homologacao",
"referencia": "string"
}
],
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string"
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Emitir MDF-e

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (MdfeSefazInfMDFe) Informações do MDF-e.
	object (MdfeSefazInfMDFeSupl) Informações suplementares do MDF-e.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infMDFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"tpAmb": 0,
"tpEmit": 0,
"tpTransp": 0,
"mod": 0,
"serie": 0,
"nMDF": 1,
"cMDF": "string",
"cDV": 0,
"modal": 0,
"dhEmi": "2019-08-24T14:15:22Z",
"tpEmis": 0,
"procEmi": "string",
"verProc": "string",
"UFIni": "string",
"UFFim": "string",
"infMunCarrega": [{"cMunCarrega": "string",
"xMunCarrega": "string"
}
],
"infPercurso": [{"UFPer": "string"
}
],
"dhIniViagem": "2019-08-24T14:15:22Z",
"indCanalVerde": 0,
"indCarregaPosterior": 0
},
"emit": {"CNPJ": "string",
"CPF": "string",
"IE": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"fone": "string",
"email": "string"
}
},
"infModal": {"versaoModal": "string",
"aereo": {"nac": "stri",
"matr": "string",
"nVoo": "string",
"cAerEmb": "stri",
"cAerDes": "stri",
"dVoo": "2019-08-24"
},
"rodo": {"infANTT": {"RNTRC": "string",
"infCIOT": [null
],
"valePed": {"disp": [ ],
"categCombVeic": null
},
"infContratante": [null
],
"infPag": [null
]
},
"veicTracao": {"cInt": "string",
"placa": "string",
"RENAVAM": "stringstr",
"tara": 0,
"capKG": 0,
"capM3": 0,
"prop": {"CPF": null,
"CNPJ": null,
"RNTRC": null,
"xNome": null,
"IE": null,
"UF": null,
"tpProp": null
},
"condutor": [null
],
"tpRod": "string",
"tpCar": "string",
"UF": "string"
},
"veicReboque": [{"cInt": null,
"placa": null,
"RENAVAM": null,
"tara": null,
"capKG": null,
"capM3": null,
"prop": null,
"tpCar": null,
"UF": null
}
],
"codAgPorto": "string",
"lacRodo": [{"nLacre": null
}
]
},
"aquav": {"irin": "string",
"tpEmb": "string",
"cEmbar": "string",
"xEmbar": "string",
"nViag": "string",
"cPrtEmb": "strin",
"cPrtDest": "strin",
"prtTrans": "string",
"tpNav": 0,
"infTermCarreg": [{"cTermCarreg": null,
"xTermCarreg": null
}
],
"infTermDescarreg": [{"cTermDescarreg": null,
"xTermDescarreg": null
}
],
"infEmbComb": [{"cEmbComb": null,
"xBalsa": null
}
],
"infUnidCargaVazia": [{"idUnidCargaVazia": null,
"tpUnidCargaVazia": null
}
],
"infUnidTranspVazia": [{"idUnidTranspVazia": null,
"tpUnidTranspVazia": null
}
],
"MMSI": "string"
},
"ferrov": {"trem": {"xPref": "string",
"dhTrem": "2019-08-24T14:15:22Z",
"xOri": "str",
"xDest": "str",
"qVag": 1
},
"vag": [{"pesoBC": null,
"pesoR": null,
"tpVag": null,
"serie": null,
"nVag": null,
"nSeq": null,
"TU": null
}
]
}
},
"infDoc": {"infMunDescarga": [{"cMunDescarga": "string",
"xMunDescarga": "string",
"infCTe": [null
],
"infNFe": [null
],
"infMDFeTransp": [null
]
}
]
},
"seg": [{"infResp": {"respSeg": 0,
"CNPJ": "string",
"CPF": "string"
},
"infSeg": {"xSeg": "string",
"CNPJ": "string"
},
"nApol": "string",
"nAver": ["string"
]
}
],
"prodPred": {"tpCarga": "string",
"xProd": "string",
"cEAN": "string",
"NCM": "string",
"infLotacao": {"infLocalCarrega": {"CEP": "string",
"latitude": "string",
"longitude": "string"
},
"infLocalDescarrega": {"CEP": "string",
"latitude": "string",
"longitude": "string"
}
}
},
"tot": {"qCTe": 0,
"qNFe": 0,
"qMDFe": 0,
"vCarga": 0,
"cUnid": "string",
"qCarga": 0
},
"lacres": [{"nLacre": "string"
}
],
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"infAdic": {"infAdFisco": "string",
"infCpl": "string"
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
}
},
"infMDFeSupl": {"qrCodMDFe": "stringstringstringstringstringstringstringstringst"
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Encerrar um MDF-e autorizado

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Request Body schema: application/json
required

data_encerramento	string or null <date> Data que o manifesto foi encerrado. Opcional. Caso não seja informada, será utilizada a data em que a solicitação foi feita à API.
uf required	string UF de encerramento do manifesto.
codigo_municipio required	string Código IBGE do Município de encerramento do manifesto.

Responses

Response Schema: application/json

data_encerramento	string <date> Data que o manifesto foi encerrado.
uf	string UF de encerramento do manifesto.
codigo_municipio	string Código do Município de encerramento do manifesto.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"data_encerramento": "2019-08-24",
"uf": "string",
"codigo_municipio": "string"
}

Response samples

Content type

application/json

{"data_encerramento": "2019-08-24",
"uf": "string",
"codigo_municipio": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Incluir um condutor em um MDF-e autorizado

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Request Body schema: application/json
required

nome_condutor required	string [ 2 .. 60 ] characters Nome do condutor.
cpf_condutor required	string CPF do condutor.

Responses

Response Schema: application/json

nome_condutor	string Nome do condutor.
cpf_condutor	string CPF do condutor.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"nome_condutor": "string",
"cpf_condutor": "string"
}

Response samples

Content type

application/json

{"nome_condutor": "string",
"cpf_condutor": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Incluir um DF-e em um MDF-e autorizado

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Request Body schema: application/json
required

codigo_municipio_carrega	string Código do Município de carregamento.
municipio_carrega	string Nome do Município de carregamento.
	Array of objects (MdfeDocumentoVinculado) Informações dos documentos fiscais vinculados ao manifesto.
protocolo_autorizacao	string

Responses

Response Schema: application/json

codigo_municipio_carrega	string Código do Município de carregamento.
municipio_carrega	string Nome do Município de carregamento.
	Array of objects (MdfeDocumentoVinculado) Informações dos documentos fiscais vinculados ao manifesto.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"codigo_municipio_carrega": "string",
"municipio_carrega": "string",
"documentos": [{"codigo_municipio_descarga": "string",
"municipio_descarga": "string",
"chave_acesso_nfe": "string"
}
],
"protocolo_autorizacao": "string"
}

Response samples

Content type

application/json

{"codigo_municipio_carrega": "string",
"municipio_carrega": "string",
"documentos": [{"codigo_municipio_descarga": "string",
"municipio_descarga": "string",
"chave_acesso_nfe": "string"
}
],
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Listar lotes de MDF-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao

Responses

Response Schema: application/json

@count	integer
	Array of objects (DfeLote)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": null,
"id": null,
"ambiente": null,
"status": null,
"autor": null,
"chave_acesso": null,
"data_evento": null,
"numero_sequencial": null,
"data_recebimento": null,
"codigo_status": null,
"motivo_status": null,
"numero_protocolo": null,
"codigo_mensagem": null,
"mensagem": null,
"tipo_evento": null
}
}
]
}
]
}

Listar MDF-e

Retorna a lista de manifestos de acordo com os critérios de busca utilizados. Os manifestos são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Dfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Sincroniza dados no MDF-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da MDF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

Sincronizar um manifesto que se encontra com o status erro na API, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
Sincronizar um manifesto que se encontra com o status autorizadona API, mas está cancelado ou encerrado na SEFAZ.
Sincronizar todos os eventos de Cancelamento, Encerramento, Inclusão de condutor e Inclusão de DF-e de um manifesto que porventura não tenham sido feitos a partir da API.

Informações adicionais:

Consumo: 1 unidade por evento sincronizado ou requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do MDF-e gerado pela API.

Responses

Response Schema: application/json

status	string Enum: "pendente" "sincronizado" "erro" Situação atual da sincronização.
codigo_status	integer Código da situação atual do DF-e.
motivo_status	string Descrição literal da situação atual do DF-e.
data_recebimento	string <date-time> Data e hora de processamento.
chave	string Chave de Acesso do DF-e consultado.

Response samples

Content type

application/json

{"status": "pendente",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"chave": "string"
}

NFC-e

Nota Fiscal de Consumidor Eletrônica.

Baixar PDF da inutilização

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do cancelamento

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do DANFCE

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
nome_fantasia	boolean Default: false Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
mensagem_rodape	string <= 120 characters Default: "" Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"`
resumido	boolean Default: false Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.
qrcode_lateral	boolean Default: false Imprime o QRCode na lateral do DANFE NFC-e. Disponível apenas para DANFE com 80 milímetros de largura.
largura	integer [ 40 .. 80 ] Default: 80 Largura do DANFE NFC-e (em milímetros).
margem	string Default: "2" Define as margens do DANFE NFC-e (em milímetros). Essa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre `0` e `9`. Quando um valor é especificado, a mesma margem é aplicada para todos os quatro lados. Quando dois valores são especificados, a primeira margem é aplicada aos lados esquerdo e direito, e a segunda aos lados superior e inferior. Quando três valores são especificados, a primeira margem é aplicada ao lado esquerdo, a segunda aos lados superior e inferior, e a terceira ao lado direito. Quando quatro valores são especificados, as margens são aplicadas aos lados esquerdo, superior, direito e inferior, nesta ordem (sentido horário). Exemplos de uso: `margem=1` Margem esquerda: 1mm Margem superior: 1mm Margem direita: 1mm Margem inferior: 1mm `margem=1,2` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 1mm Margem inferior: 2mm `margem=1,2,3` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 3mm Margem inferior: 2mm `margem=1,2,3,4` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 3mm Margem inferior: 4mm

Responses

Response Schema: /

string <binary>

Baixar PDF do evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da inutilização

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da NFC-e

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da NFC-e processada

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz nfeProc).

O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /nfce/{id}/xml/nota.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do evento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do Protocolo da SEFAZ

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: /

string <binary>

Cancelar uma NFC-e autorizada

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Request Body schema: application/json

chave_substituta	string Chave de acesso da NFC-e substituta. Quando informada, o cancelamento é enviado à SEFAZ como evento de "Cancelamento por substituição" (110112), no lugar do cancelamento comum (110111). A NFC-e substituta precisa constar na API, pertencer à mesma empresa, ter sido emitida no mesmo ambiente e estar autorizada.
justificativa	string Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"chave_substituta": "string",
"justificativa": "string"
}

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Comandos ESC/POS para impressão do DANFCE

ESC/POS é um sistema de comando criado pela Epson usado em diversos sistemas de impressoras POS.

Com o formato ESC/POS, você poderá imprimir nativamente em uma vasta quantidade de modelos de impressora térmicas utilizadas no Brasil e no mundo. Com ela, você consegue fazer o envio de comandos em ESC/POS direto para a porta da impressora.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

query Parameters

modelo	integer [ 0 .. 13 ] Default: 1 Modelo da impressora: `0` - Texto `1` - Epson `2` - Bematech `3` - Daruma `4` - Vox `5` - Diebold `6` - Epson P2 `7` - CustomPos `8` - Star `9` - Zjiang `10` - GPrinter `11` - Datecs `12` - Sunmi `13` - Externo
colunas	integer Default: 48 Define o máximo de caracteres, em uma linha, usando a fonte normal. Ex: 40, 42, 48, 58, 80.
qrcode_lateral	boolean Default: false Imprime o QRCode na lateral do DANFCe. OBS: não suportado por alguns modelos de impressora.

Responses

Response Schema: /

string <binary>

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 7.0, item 5.5.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF/CNPJ do emitente. Utilize o valor sem máscara.
autorizador	string Ambiente Autorizador. Autorizadores disponíveis: `AM`, `BA`, `CE`, `GO`, `MG`, `MS`, `MT`, `PE`, `PR`, `RS`, `SP`, `SVRS`. Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response Schema: application/json

autorizador	string Enum: "AM" "BA" "CE" "GO" "MG" "MS" "MT" "PE" "PR" "RS" "SP" "SVAN" "SVRS" "SVCAN" "SVCRS" "AN" "SVSP" "SVCSP" SEFAZ autorizadora responsável.
ambiente	string Enum: "homologacao" "producao" Identificação do Ambiente.
data_hora_consulta	string <date-time> Data e hora da consulta.
codigo_status	integer Código do status da mensagem enviada.
motivo_status	string Descrição literal do status do serviço solicitado.
tempo_medio_resposta	integer or null Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.
data_hora_retorno	string or null <date-time> Data e hora prevista para o retorno dos serviços prestados.

Response samples

Content type

application/json

{"autorizador": "AM",
"ambiente": "homologacao",
"data_hora_consulta": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"tempo_medio_resposta": 0,
"data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar a inutilização de sequência de numeração

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: application/json

cnpj	string
ano	integer
modelo	integer
serie	integer
numero_inicial	integer
numero_final	integer
justificativa	string
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"cnpj": "string",
"ano": 0,
"modelo": 0,
"serie": 0,
"numero_inicial": 0,
"numero_final": 0,
"justificativa": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar lote de NFC-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único do lote gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
created_at	string <date-time>
status	string Enum: "pendente" "processado" "erro"
ambiente	string Enum: "homologacao" "producao"
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote	string or null
	object (DfeRecibo)
	Array of objects (Dfe)

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Consultar NFC-e

Consulta os detalhes de uma NFC-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de notas e a API irá retornar as informações da nota correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Consultar o cancelamento da NFC-e

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Emitir lote de NFC-e

Informações adicionais:

Consumo: 1 unidade por NFC-e.

Authorizations:

oauth2

Request Body schema: application/json
required

required	Array of objects (NfePedidoEmissao) [ 1 .. 50 ] items
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string <= 50 characters Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote required	string

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
created_at	string <date-time>
status	string Enum: "pendente" "processado" "erro"
ambiente	string Enum: "homologacao" "producao"
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote	string or null
	object (DfeRecibo)
	Array of objects (Dfe)

Request samples

Payload

Content type

application/json

{"documentos": [{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [null
],
"gCompraGov": {"tpEnteGov": null,
"pRedutor": null,
"tpOperGov": null,
"refDFeAnt": [ ]
},
"gPagAntecipado": {"refNFe": [ ]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": null,
"nro": null,
"xCpl": null,
"xBairro": null,
"cMun": null,
"xMun": null,
"UF": null,
"CEP": null,
"cPais": null,
"xPais": null,
"fone": null
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": null,
"nro": null,
"xCpl": null,
"xBairro": null,
"cMun": null,
"xMun": null,
"UF": null,
"CEP": null,
"cPais": null,
"xPais": null,
"fone": null
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": null,
"CPF": null
}
],
"det": [{"nItem": null,
"prod": null,
"imposto": null,
"impostoDevol": null,
"infAdProd": null,
"obsItem": null,
"vItem": null,
"DFeReferenciado": null
}
],
"total": {"ICMSTot": {"vBC": null,
"vICMS": null,
"vICMSDeson": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null,
"vFCP": null,
"vBCST": null,
"vST": null,
"vFCPST": null,
"vFCPSTRet": null,
"qBCMono": null,
"vICMSMono": null,
"qBCMonoReten": null,
"vICMSMonoReten": null,
"qBCMonoRet": null,
"vICMSMonoRet": null,
"vProd": null,
"vFrete": null,
"vSeg": null,
"vDesc": null,
"vII": null,
"vIPI": null,
"vIPIDevol": null,
"vPIS": null,
"vCOFINS": null,
"vOutro": null,
"vNF": null,
"vTotTrib": null
},
"ISSQNtot": {"vServ": null,
"vBC": null,
"vISS": null,
"vPIS": null,
"vCOFINS": null,
"dCompet": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"cRegTrib": null
},
"retTrib": {"vRetPIS": null,
"vRetCOFINS": null,
"vRetCSLL": null,
"vBCIRRF": null,
"vIRRF": null,
"vBCRetPrev": null,
"vRetPrev": null
},
"ISTot": {"vIS": null
},
"IBSCBSTot": {"vBCIBSCBS": null,
"gIBS": null,
"gCBS": null,
"gMono": null,
"gEstornoCred": null
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": null,
"CPF": null,
"xNome": null,
"IE": null,
"xEnder": null,
"xMun": null,
"UF": null
},
"retTransp": {"vServ": null,
"vBCRet": null,
"pICMSRet": null,
"vICMSRet": null,
"CFOP": null,
"cMunFG": null
},
"veicTransp": {"placa": null,
"UF": null,
"RNTC": null
},
"reboque": [null
],
"vagao": "string",
"balsa": "string",
"vol": [null
]
},
"cobr": {"fat": {"nFat": null,
"vOrig": null,
"vDesc": null,
"vLiq": null
},
"dup": [null
]
},
"pag": {"detPag": [null
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [null
],
"obsFisco": [null
],
"procRef": [null
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [null
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [null
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [null
],
"guiaTransito": {"tpGuia": null,
"UFGuia": null,
"serieGuia": null,
"nGuia": null
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": null,
"RSAKeyValue": null
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}
],
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string"
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Emitir NFC-e

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (NfeSefazInfNFe) Informações da Nota Fiscal eletrônica.
	object (NfeSefazInfNFeSupl) Informações suplementares Nota Fiscal.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [{"refNFe": "string",
"refNFeSig": "string",
"refNF": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"mod": null,
"serie": null,
"nNF": null
},
"refNFP": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"CPF": null,
"IE": null,
"mod": null,
"serie": null,
"nNF": null
},
"refCTe": "string",
"refECF": {"mod": null,
"nECF": null,
"nCOO": null
}
}
],
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"gPagAntecipado": {"refNFe": ["string"
]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"det": [{"nItem": 1,
"prod": {"cProd": "string",
"cEAN": "string",
"cBarra": "string",
"xProd": "string",
"NCM": "string",
"NVE": [null
],
"CEST": "string",
"indEscala": "string",
"CNPJFab": "string",
"cBenef": "string",
"gCred": [null
],
"tpCredPresIBSZFM": 0,
"EXTIPI": "string",
"CFOP": "string",
"uCom": "string",
"qCom": 0,
"vUnCom": 0,
"vProd": 0,
"cEANTrib": "string",
"cBarraTrib": "string",
"uTrib": "string",
"qTrib": 0,
"vUnTrib": 0,
"vFrete": 1,
"vSeg": 1,
"vDesc": 1,
"vOutro": 1,
"indTot": 0,
"indBemMovelUsado": 0,
"DI": [null
],
"detExport": [null
],
"xPed": "string",
"nItemPed": 0,
"nFCI": "string",
"rastro": [null
],
"infProdNFF": {"cProdFisco": null,
"cOperNFF": null
},
"infProdEmb": {"xEmb": null,
"qVolEmb": null,
"uEmb": null
},
"veicProd": {"tpOp": null,
"chassi": null,
"cCor": null,
"xCor": null,
"pot": null,
"cilin": null,
"pesoL": null,
"pesoB": null,
"nSerie": null,
"tpComb": null,
"nMotor": null,
"CMT": null,
"dist": null,
"anoMod": null,
"anoFab": null,
"tpPint": null,
"tpVeic": null,
"espVeic": null,
"VIN": null,
"condVeic": null,
"cMod": null,
"cCorDENATRAN": null,
"lota": null,
"tpRest": null
},
"med": {"cProdANVISA": null,
"xMotivoIsencao": null,
"vPMC": null
},
"arma": [null
],
"comb": {"cProdANP": null,
"descANP": null,
"pGLP": null,
"pGNn": null,
"pGNi": null,
"vPart": null,
"CODIF": null,
"qTemp": null,
"UFCons": null,
"CIDE": null,
"encerrante": null,
"pBio": null,
"origComb": [ ]
},
"nRECOPI": "string"
},
"imposto": {"vTotTrib": 0,
"ICMS": {"ICMS00": null,
"ICMS02": null,
"ICMS10": null,
"ICMS15": null,
"ICMS20": null,
"ICMS30": null,
"ICMS40": null,
"ICMS51": null,
"ICMS53": null,
"ICMS60": null,
"ICMS61": null,
"ICMS70": null,
"ICMS90": null,
"ICMSPart": null,
"ICMSST": null,
"ICMSSN101": null,
"ICMSSN102": null,
"ICMSSN201": null,
"ICMSSN202": null,
"ICMSSN500": null,
"ICMSSN900": null
},
"IPI": {"CNPJProd": null,
"cSelo": null,
"qSelo": null,
"cEnq": null,
"IPITrib": null,
"IPINT": null
},
"II": {"vBC": null,
"vDespAdu": null,
"vII": null,
"vIOF": null
},
"ISSQN": {"vBC": null,
"vAliq": null,
"vISSQN": null,
"cMunFG": null,
"cListServ": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"indISS": null,
"cServico": null,
"cMun": null,
"cPais": null,
"nProcesso": null,
"indIncentivo": null
},
"PIS": {"PISAliq": null,
"PISQtde": null,
"PISNT": null,
"PISOutr": null
},
"PISST": {"vBC": null,
"pPIS": null,
"qBCProd": null,
"vAliqProd": null,
"vPIS": null,
"indSomaPISST": null
},
"COFINS": {"COFINSAliq": null,
"COFINSQtde": null,
"COFINSNT": null,
"COFINSOutr": null
},
"COFINSST": {"vBC": null,
"pCOFINS": null,
"qBCProd": null,
"vAliqProd": null,
"vCOFINS": null,
"indSomaCOFINSST": null
},
"ICMSUFDest": {"vBCUFDest": null,
"vBCFCPUFDest": null,
"pFCPUFDest": null,
"pICMSUFDest": null,
"pICMSInter": null,
"pICMSInterPart": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null
},
"IS": {"CSTIS": null,
"cClassTribIS": null,
"vBCIS": null,
"pIS": null,
"adRemIS": null,
"uTrib": null,
"qTrib": null,
"vIS": null
},
"IBSCBS": {"CST": null,
"cClassTrib": null,
"indDoacao": null,
"gIBSCBS": null,
"gIBSCBSMono": null,
"gTransfCred": null,
"gAjusteCompet": null,
"gEstornoCred": null,
"gCredPresOper": null,
"gCredPresIBSZFM": null
}
},
"impostoDevol": {"pDevol": 0,
"IPI": {"vIPIDevol": null
}
},
"infAdProd": "string",
"obsItem": {"obsCont": {"xCampo": null,
"xTexto": null
},
"obsFisco": {"xCampo": null,
"xTexto": null
}
},
"vItem": 0,
"DFeReferenciado": {"chaveAcesso": "string",
"nItem": 1
}
}
],
"total": {"ICMSTot": {"vBC": 0,
"vICMS": 0,
"vICMSDeson": 0,
"vFCPUFDest": 0,
"vICMSUFDest": 0,
"vICMSUFRemet": 0,
"vFCP": 0,
"vBCST": 0,
"vST": 0,
"vFCPST": 0,
"vFCPSTRet": 0,
"qBCMono": 0,
"vICMSMono": 0,
"qBCMonoReten": 0,
"vICMSMonoReten": 0,
"qBCMonoRet": 0,
"vICMSMonoRet": 0,
"vProd": 0,
"vFrete": 0,
"vSeg": 0,
"vDesc": 0,
"vII": 0,
"vIPI": 0,
"vIPIDevol": 0,
"vPIS": 0,
"vCOFINS": 0,
"vOutro": 0,
"vNF": 0,
"vTotTrib": 0
},
"ISSQNtot": {"vServ": 1,
"vBC": 1,
"vISS": 1,
"vPIS": 1,
"vCOFINS": 1,
"dCompet": "2019-08-24",
"vDeducao": 1,
"vOutro": 1,
"vDescIncond": 1,
"vDescCond": 1,
"vISSRet": 1,
"cRegTrib": 0
},
"retTrib": {"vRetPIS": 1,
"vRetCOFINS": 1,
"vRetCSLL": 1,
"vBCIRRF": 1,
"vIRRF": 1,
"vBCRetPrev": 1,
"vRetPrev": 1
},
"ISTot": {"vIS": 0
},
"IBSCBSTot": {"vBCIBSCBS": 0,
"gIBS": {"gIBSUF": {"vDif": null,
"vDevTrib": null,
"vIBSUF": null
},
"gIBSMun": {"vDif": null,
"vDevTrib": null,
"vIBSMun": null
},
"vIBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gCBS": {"vDif": 0,
"vDevTrib": 0,
"vCBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gMono": {"vIBSMono": 0,
"vCBSMono": 0,
"vIBSMonoReten": 0,
"vCBSMonoReten": 0,
"vIBSMonoRet": 0,
"vCBSMonoRet": 0
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"IE": "string",
"xEnder": "string",
"xMun": "string",
"UF": "string"
},
"retTransp": {"vServ": 0,
"vBCRet": 0,
"pICMSRet": 0,
"vICMSRet": 0,
"CFOP": "string",
"cMunFG": "string"
},
"veicTransp": {"placa": "string",
"UF": "string",
"RNTC": "string"
},
"reboque": [{"placa": "string",
"UF": "string",
"RNTC": "string"
}
],
"vagao": "string",
"balsa": "string",
"vol": [{"qVol": 0,
"esp": "string",
"marca": "string",
"nVol": "string",
"pesoL": 0,
"pesoB": 0,
"lacres": [null
]
}
]
},
"cobr": {"fat": {"nFat": "string",
"vOrig": 0,
"vDesc": 0,
"vLiq": 0
},
"dup": [{"nDup": "string",
"dVenc": "2019-08-24",
"vDup": 1
}
]
},
"pag": {"detPag": [{"indPag": 0,
"tPag": "string",
"xPag": "string",
"vPag": 0,
"dPag": "2019-08-24",
"CNPJPag": "string",
"UFPag": "string",
"card": {"tpIntegra": null,
"CNPJ": null,
"tBand": null,
"cAut": null,
"CNPJReceb": null,
"idTermPag": null
}
}
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsFisco": [{"xCampo": "string",
"xTexto": "string"
}
],
"procRef": [{"nProc": "string",
"indProc": 0,
"tpAto": "string"
}
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [{"dia": 1,
"qtde": 0
}
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [{"xDed": "string",
"vDed": 0
}
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [{"nReceituario": "string",
"CPFRespTec": "string"
}
],
"guiaTransito": {"tpGuia": 0,
"UFGuia": "string",
"serieGuia": "string",
"nGuia": "string"
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": "string",
"RSAKeyValue": {"Modulus": "string",
"Exponent": "string"
}
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Enviar e-mail

Envia o XML e PDF da nota via email.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
nome_fantasia	boolean Default: false Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
mensagem_rodape	string <= 120 characters Default: "" Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"`
resumido	boolean Default: false Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.
qrcode_lateral	boolean Default: false Imprime o QRCode na lateral do DANFE NFC-e. Disponível apenas para DANFE com 80 milímetros de largura.
largura	integer [ 40 .. 80 ] Default: 80 Largura do DANFE NFC-e (em milímetros).
margem	string Default: "2" Define as margens do DANFE NFC-e (em milímetros). Essa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre `0` e `9`. Quando um valor é especificado, a mesma margem é aplicada para todos os quatro lados. Quando dois valores são especificados, a primeira margem é aplicada aos lados esquerdo e direito, e a segunda aos lados superior e inferior. Quando três valores são especificados, a primeira margem é aplicada ao lado esquerdo, a segunda aos lados superior e inferior, e a terceira ao lado direito. Quando quatro valores são especificados, as margens são aplicadas aos lados esquerdo, superior, direito e inferior, nesta ordem (sentido horário). Exemplos de uso: `margem=1` Margem esquerda: 1mm Margem superior: 1mm Margem direita: 1mm Margem inferior: 1mm `margem=1,2` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 1mm Margem inferior: 2mm `margem=1,2,3` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 3mm Margem inferior: 2mm `margem=1,2,3,4` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 3mm Margem inferior: 4mm

Request Body schema: application/json

Array of objects (EnderecoEmail) <= 10 items

Lista de endereços de email para envio dos arquivos.

Caso nenhum email seja informado, será utilizado o email do destinatário do documento fiscal.

Array (<= 10 items)

required

string

Email do destinatário.

Responses

Response Schema: application/json

id required	string ID único gerado pela API para este email. Utilize-o no endpoint de consulta de email para obter informações detalhadas sobre o envio do email e rastrear todos os eventos relacionados, como envio, entrega, falhas e outros eventos relevantes.
status	string Enum: "pending" "sending" "sent" "delivered" "delivery_delayed" "bounced" "complained" "rejected" "cancelled" "failed"
status_message	string or null

Request samples

Payload

Content type

application/json

{"destinatarios": [{"email": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"status": "pending",
"status_message": "string"
}

Inutilizar uma sequência de numeração de NFC-e

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
cnpj required	string CNPJ do emitente.
ano required	integer Ano de inutilização da numeração.
serie required	integer [ 0 .. 999 ] Série da NF-e.
numero_inicial required	integer [ 1 .. 999999999 ] Número da NF-e inicial.
numero_final required	integer [ 1 .. 999999999 ] Número da NF-e final.
justificativa required	string [ 15 .. 255 ] characters Justificativa do pedido de inutilização.

Responses

Response Schema: application/json

cnpj	string
ano	integer
modelo	integer
serie	integer
numero_inicial	integer
numero_final	integer
justificativa	string
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"ambiente": "homologacao",
"cnpj": "string",
"ano": 0,
"serie": 0,
"numero_inicial": 1,
"numero_final": 1,
"justificativa": "stringstringstr"
}

Response samples

Content type

application/json

{"cnpj": "string",
"ano": 0,
"modelo": 0,
"serie": 0,
"numero_inicial": 0,
"numero_final": 0,
"justificativa": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Listar eventos

Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
dfe_id required	string ID único gerado pela API para o documento fiscal.

Responses

Response Schema: application/json

@count	integer
	Array of objects (DfeEvento)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
]
}

Listar lotes de NFC-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao

Responses

Response Schema: application/json

@count	integer
	Array of objects (DfeLote)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": null,
"id": null,
"ambiente": null,
"status": null,
"autor": null,
"chave_acesso": null,
"data_evento": null,
"numero_sequencial": null,
"data_recebimento": null,
"codigo_status": null,
"motivo_status": null,
"numero_protocolo": null,
"codigo_mensagem": null,
"mensagem": null,
"tipo_evento": null
}
}
]
}
]
}

Listar NFC-e

Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Dfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Prévia do PDF do DANFCE

Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do DANFCE.

Os dados de entrada são os mesmos do endpoint de emissão de NFC-e (POST /nfce).

Atenção: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
nome_fantasia	boolean Default: false Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
mensagem_rodape	string <= 120 characters Default: "" Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"`
resumido	boolean Default: false Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.
qrcode_lateral	boolean Default: false Imprime o QRCode na lateral do DANFE NFC-e. Disponível apenas para DANFE com 80 milímetros de largura.
largura	integer [ 40 .. 80 ] Default: 80 Largura do DANFE NFC-e (em milímetros).
margem	string Default: "2" Define as margens do DANFE NFC-e (em milímetros). Essa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre `0` e `9`. Quando um valor é especificado, a mesma margem é aplicada para todos os quatro lados. Quando dois valores são especificados, a primeira margem é aplicada aos lados esquerdo e direito, e a segunda aos lados superior e inferior. Quando três valores são especificados, a primeira margem é aplicada ao lado esquerdo, a segunda aos lados superior e inferior, e a terceira ao lado direito. Quando quatro valores são especificados, as margens são aplicadas aos lados esquerdo, superior, direito e inferior, nesta ordem (sentido horário). Exemplos de uso: `margem=1` Margem esquerda: 1mm Margem superior: 1mm Margem direita: 1mm Margem inferior: 1mm `margem=1,2` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 1mm Margem inferior: 2mm `margem=1,2,3` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 3mm Margem inferior: 2mm `margem=1,2,3,4` Margem esquerda: 1mm Margem superior: 2mm Margem direita: 3mm Margem inferior: 4mm

Request Body schema: application/json
required

required	object (NfeSefazInfNFe) Informações da Nota Fiscal eletrônica.
	object (NfeSefazInfNFeSupl) Informações suplementares Nota Fiscal.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: /

string <binary>

Request samples

Payload

Content type

application/json

{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [{"refNFe": "string",
"refNFeSig": "string",
"refNF": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"mod": null,
"serie": null,
"nNF": null
},
"refNFP": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"CPF": null,
"IE": null,
"mod": null,
"serie": null,
"nNF": null
},
"refCTe": "string",
"refECF": {"mod": null,
"nECF": null,
"nCOO": null
}
}
],
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"gPagAntecipado": {"refNFe": ["string"
]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"det": [{"nItem": 1,
"prod": {"cProd": "string",
"cEAN": "string",
"cBarra": "string",
"xProd": "string",
"NCM": "string",
"NVE": [null
],
"CEST": "string",
"indEscala": "string",
"CNPJFab": "string",
"cBenef": "string",
"gCred": [null
],
"tpCredPresIBSZFM": 0,
"EXTIPI": "string",
"CFOP": "string",
"uCom": "string",
"qCom": 0,
"vUnCom": 0,
"vProd": 0,
"cEANTrib": "string",
"cBarraTrib": "string",
"uTrib": "string",
"qTrib": 0,
"vUnTrib": 0,
"vFrete": 1,
"vSeg": 1,
"vDesc": 1,
"vOutro": 1,
"indTot": 0,
"indBemMovelUsado": 0,
"DI": [null
],
"detExport": [null
],
"xPed": "string",
"nItemPed": 0,
"nFCI": "string",
"rastro": [null
],
"infProdNFF": {"cProdFisco": null,
"cOperNFF": null
},
"infProdEmb": {"xEmb": null,
"qVolEmb": null,
"uEmb": null
},
"veicProd": {"tpOp": null,
"chassi": null,
"cCor": null,
"xCor": null,
"pot": null,
"cilin": null,
"pesoL": null,
"pesoB": null,
"nSerie": null,
"tpComb": null,
"nMotor": null,
"CMT": null,
"dist": null,
"anoMod": null,
"anoFab": null,
"tpPint": null,
"tpVeic": null,
"espVeic": null,
"VIN": null,
"condVeic": null,
"cMod": null,
"cCorDENATRAN": null,
"lota": null,
"tpRest": null
},
"med": {"cProdANVISA": null,
"xMotivoIsencao": null,
"vPMC": null
},
"arma": [null
],
"comb": {"cProdANP": null,
"descANP": null,
"pGLP": null,
"pGNn": null,
"pGNi": null,
"vPart": null,
"CODIF": null,
"qTemp": null,
"UFCons": null,
"CIDE": null,
"encerrante": null,
"pBio": null,
"origComb": [ ]
},
"nRECOPI": "string"
},
"imposto": {"vTotTrib": 0,
"ICMS": {"ICMS00": null,
"ICMS02": null,
"ICMS10": null,
"ICMS15": null,
"ICMS20": null,
"ICMS30": null,
"ICMS40": null,
"ICMS51": null,
"ICMS53": null,
"ICMS60": null,
"ICMS61": null,
"ICMS70": null,
"ICMS90": null,
"ICMSPart": null,
"ICMSST": null,
"ICMSSN101": null,
"ICMSSN102": null,
"ICMSSN201": null,
"ICMSSN202": null,
"ICMSSN500": null,
"ICMSSN900": null
},
"IPI": {"CNPJProd": null,
"cSelo": null,
"qSelo": null,
"cEnq": null,
"IPITrib": null,
"IPINT": null
},
"II": {"vBC": null,
"vDespAdu": null,
"vII": null,
"vIOF": null
},
"ISSQN": {"vBC": null,
"vAliq": null,
"vISSQN": null,
"cMunFG": null,
"cListServ": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"indISS": null,
"cServico": null,
"cMun": null,
"cPais": null,
"nProcesso": null,
"indIncentivo": null
},
"PIS": {"PISAliq": null,
"PISQtde": null,
"PISNT": null,
"PISOutr": null
},
"PISST": {"vBC": null,
"pPIS": null,
"qBCProd": null,
"vAliqProd": null,
"vPIS": null,
"indSomaPISST": null
},
"COFINS": {"COFINSAliq": null,
"COFINSQtde": null,
"COFINSNT": null,
"COFINSOutr": null
},
"COFINSST": {"vBC": null,
"pCOFINS": null,
"qBCProd": null,
"vAliqProd": null,
"vCOFINS": null,
"indSomaCOFINSST": null
},
"ICMSUFDest": {"vBCUFDest": null,
"vBCFCPUFDest": null,
"pFCPUFDest": null,
"pICMSUFDest": null,
"pICMSInter": null,
"pICMSInterPart": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null
},
"IS": {"CSTIS": null,
"cClassTribIS": null,
"vBCIS": null,
"pIS": null,
"adRemIS": null,
"uTrib": null,
"qTrib": null,
"vIS": null
},
"IBSCBS": {"CST": null,
"cClassTrib": null,
"indDoacao": null,
"gIBSCBS": null,
"gIBSCBSMono": null,
"gTransfCred": null,
"gAjusteCompet": null,
"gEstornoCred": null,
"gCredPresOper": null,
"gCredPresIBSZFM": null
}
},
"impostoDevol": {"pDevol": 0,
"IPI": {"vIPIDevol": null
}
},
"infAdProd": "string",
"obsItem": {"obsCont": {"xCampo": null,
"xTexto": null
},
"obsFisco": {"xCampo": null,
"xTexto": null
}
},
"vItem": 0,
"DFeReferenciado": {"chaveAcesso": "string",
"nItem": 1
}
}
],
"total": {"ICMSTot": {"vBC": 0,
"vICMS": 0,
"vICMSDeson": 0,
"vFCPUFDest": 0,
"vICMSUFDest": 0,
"vICMSUFRemet": 0,
"vFCP": 0,
"vBCST": 0,
"vST": 0,
"vFCPST": 0,
"vFCPSTRet": 0,
"qBCMono": 0,
"vICMSMono": 0,
"qBCMonoReten": 0,
"vICMSMonoReten": 0,
"qBCMonoRet": 0,
"vICMSMonoRet": 0,
"vProd": 0,
"vFrete": 0,
"vSeg": 0,
"vDesc": 0,
"vII": 0,
"vIPI": 0,
"vIPIDevol": 0,
"vPIS": 0,
"vCOFINS": 0,
"vOutro": 0,
"vNF": 0,
"vTotTrib": 0
},
"ISSQNtot": {"vServ": 1,
"vBC": 1,
"vISS": 1,
"vPIS": 1,
"vCOFINS": 1,
"dCompet": "2019-08-24",
"vDeducao": 1,
"vOutro": 1,
"vDescIncond": 1,
"vDescCond": 1,
"vISSRet": 1,
"cRegTrib": 0
},
"retTrib": {"vRetPIS": 1,
"vRetCOFINS": 1,
"vRetCSLL": 1,
"vBCIRRF": 1,
"vIRRF": 1,
"vBCRetPrev": 1,
"vRetPrev": 1
},
"ISTot": {"vIS": 0
},
"IBSCBSTot": {"vBCIBSCBS": 0,
"gIBS": {"gIBSUF": {"vDif": null,
"vDevTrib": null,
"vIBSUF": null
},
"gIBSMun": {"vDif": null,
"vDevTrib": null,
"vIBSMun": null
},
"vIBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gCBS": {"vDif": 0,
"vDevTrib": 0,
"vCBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gMono": {"vIBSMono": 0,
"vCBSMono": 0,
"vIBSMonoReten": 0,
"vCBSMonoReten": 0,
"vIBSMonoRet": 0,
"vCBSMonoRet": 0
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"IE": "string",
"xEnder": "string",
"xMun": "string",
"UF": "string"
},
"retTransp": {"vServ": 0,
"vBCRet": 0,
"pICMSRet": 0,
"vICMSRet": 0,
"CFOP": "string",
"cMunFG": "string"
},
"veicTransp": {"placa": "string",
"UF": "string",
"RNTC": "string"
},
"reboque": [{"placa": "string",
"UF": "string",
"RNTC": "string"
}
],
"vagao": "string",
"balsa": "string",
"vol": [{"qVol": 0,
"esp": "string",
"marca": "string",
"nVol": "string",
"pesoL": 0,
"pesoB": 0,
"lacres": [null
]
}
]
},
"cobr": {"fat": {"nFat": "string",
"vOrig": 0,
"vDesc": 0,
"vLiq": 0
},
"dup": [{"nDup": "string",
"dVenc": "2019-08-24",
"vDup": 1
}
]
},
"pag": {"detPag": [{"indPag": 0,
"tPag": "string",
"xPag": "string",
"vPag": 0,
"dPag": "2019-08-24",
"CNPJPag": "string",
"UFPag": "string",
"card": {"tpIntegra": null,
"CNPJ": null,
"tBand": null,
"cAut": null,
"CNPJReceb": null,
"idTermPag": null
}
}
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsFisco": [{"xCampo": "string",
"xTexto": "string"
}
],
"procRef": [{"nProc": "string",
"indProc": 0,
"tpAto": "string"
}
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [{"dia": 1,
"qtde": 0
}
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [{"xDed": "string",
"vDed": 0
}
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [{"nReceituario": "string",
"CPFRespTec": "string"
}
],
"guiaTransito": {"tpGuia": 0,
"UFGuia": "string",
"serieGuia": "string",
"nGuia": "string"
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": "string",
"RSAKeyValue": {"Modulus": "string",
"Exponent": "string"
}
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}

Prévia do XML da NFC-e

Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do XML, sem a assinatura digital.

Os dados de entrada são os mesmos do endpoint de emissão de NFC-e (POST /nfce).

Atenção: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (NfeSefazInfNFe) Informações da Nota Fiscal eletrônica.
	object (NfeSefazInfNFeSupl) Informações suplementares Nota Fiscal.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: /

string <binary>

Request samples

Payload

Content type

application/json

{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [{"refNFe": "string",
"refNFeSig": "string",
"refNF": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"mod": null,
"serie": null,
"nNF": null
},
"refNFP": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"CPF": null,
"IE": null,
"mod": null,
"serie": null,
"nNF": null
},
"refCTe": "string",
"refECF": {"mod": null,
"nECF": null,
"nCOO": null
}
}
],
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"gPagAntecipado": {"refNFe": ["string"
]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"det": [{"nItem": 1,
"prod": {"cProd": "string",
"cEAN": "string",
"cBarra": "string",
"xProd": "string",
"NCM": "string",
"NVE": [null
],
"CEST": "string",
"indEscala": "string",
"CNPJFab": "string",
"cBenef": "string",
"gCred": [null
],
"tpCredPresIBSZFM": 0,
"EXTIPI": "string",
"CFOP": "string",
"uCom": "string",
"qCom": 0,
"vUnCom": 0,
"vProd": 0,
"cEANTrib": "string",
"cBarraTrib": "string",
"uTrib": "string",
"qTrib": 0,
"vUnTrib": 0,
"vFrete": 1,
"vSeg": 1,
"vDesc": 1,
"vOutro": 1,
"indTot": 0,
"indBemMovelUsado": 0,
"DI": [null
],
"detExport": [null
],
"xPed": "string",
"nItemPed": 0,
"nFCI": "string",
"rastro": [null
],
"infProdNFF": {"cProdFisco": null,
"cOperNFF": null
},
"infProdEmb": {"xEmb": null,
"qVolEmb": null,
"uEmb": null
},
"veicProd": {"tpOp": null,
"chassi": null,
"cCor": null,
"xCor": null,
"pot": null,
"cilin": null,
"pesoL": null,
"pesoB": null,
"nSerie": null,
"tpComb": null,
"nMotor": null,
"CMT": null,
"dist": null,
"anoMod": null,
"anoFab": null,
"tpPint": null,
"tpVeic": null,
"espVeic": null,
"VIN": null,
"condVeic": null,
"cMod": null,
"cCorDENATRAN": null,
"lota": null,
"tpRest": null
},
"med": {"cProdANVISA": null,
"xMotivoIsencao": null,
"vPMC": null
},
"arma": [null
],
"comb": {"cProdANP": null,
"descANP": null,
"pGLP": null,
"pGNn": null,
"pGNi": null,
"vPart": null,
"CODIF": null,
"qTemp": null,
"UFCons": null,
"CIDE": null,
"encerrante": null,
"pBio": null,
"origComb": [ ]
},
"nRECOPI": "string"
},
"imposto": {"vTotTrib": 0,
"ICMS": {"ICMS00": null,
"ICMS02": null,
"ICMS10": null,
"ICMS15": null,
"ICMS20": null,
"ICMS30": null,
"ICMS40": null,
"ICMS51": null,
"ICMS53": null,
"ICMS60": null,
"ICMS61": null,
"ICMS70": null,
"ICMS90": null,
"ICMSPart": null,
"ICMSST": null,
"ICMSSN101": null,
"ICMSSN102": null,
"ICMSSN201": null,
"ICMSSN202": null,
"ICMSSN500": null,
"ICMSSN900": null
},
"IPI": {"CNPJProd": null,
"cSelo": null,
"qSelo": null,
"cEnq": null,
"IPITrib": null,
"IPINT": null
},
"II": {"vBC": null,
"vDespAdu": null,
"vII": null,
"vIOF": null
},
"ISSQN": {"vBC": null,
"vAliq": null,
"vISSQN": null,
"cMunFG": null,
"cListServ": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"indISS": null,
"cServico": null,
"cMun": null,
"cPais": null,
"nProcesso": null,
"indIncentivo": null
},
"PIS": {"PISAliq": null,
"PISQtde": null,
"PISNT": null,
"PISOutr": null
},
"PISST": {"vBC": null,
"pPIS": null,
"qBCProd": null,
"vAliqProd": null,
"vPIS": null,
"indSomaPISST": null
},
"COFINS": {"COFINSAliq": null,
"COFINSQtde": null,
"COFINSNT": null,
"COFINSOutr": null
},
"COFINSST": {"vBC": null,
"pCOFINS": null,
"qBCProd": null,
"vAliqProd": null,
"vCOFINS": null,
"indSomaCOFINSST": null
},
"ICMSUFDest": {"vBCUFDest": null,
"vBCFCPUFDest": null,
"pFCPUFDest": null,
"pICMSUFDest": null,
"pICMSInter": null,
"pICMSInterPart": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null
},
"IS": {"CSTIS": null,
"cClassTribIS": null,
"vBCIS": null,
"pIS": null,
"adRemIS": null,
"uTrib": null,
"qTrib": null,
"vIS": null
},
"IBSCBS": {"CST": null,
"cClassTrib": null,
"indDoacao": null,
"gIBSCBS": null,
"gIBSCBSMono": null,
"gTransfCred": null,
"gAjusteCompet": null,
"gEstornoCred": null,
"gCredPresOper": null,
"gCredPresIBSZFM": null
}
},
"impostoDevol": {"pDevol": 0,
"IPI": {"vIPIDevol": null
}
},
"infAdProd": "string",
"obsItem": {"obsCont": {"xCampo": null,
"xTexto": null
},
"obsFisco": {"xCampo": null,
"xTexto": null
}
},
"vItem": 0,
"DFeReferenciado": {"chaveAcesso": "string",
"nItem": 1
}
}
],
"total": {"ICMSTot": {"vBC": 0,
"vICMS": 0,
"vICMSDeson": 0,
"vFCPUFDest": 0,
"vICMSUFDest": 0,
"vICMSUFRemet": 0,
"vFCP": 0,
"vBCST": 0,
"vST": 0,
"vFCPST": 0,
"vFCPSTRet": 0,
"qBCMono": 0,
"vICMSMono": 0,
"qBCMonoReten": 0,
"vICMSMonoReten": 0,
"qBCMonoRet": 0,
"vICMSMonoRet": 0,
"vProd": 0,
"vFrete": 0,
"vSeg": 0,
"vDesc": 0,
"vII": 0,
"vIPI": 0,
"vIPIDevol": 0,
"vPIS": 0,
"vCOFINS": 0,
"vOutro": 0,
"vNF": 0,
"vTotTrib": 0
},
"ISSQNtot": {"vServ": 1,
"vBC": 1,
"vISS": 1,
"vPIS": 1,
"vCOFINS": 1,
"dCompet": "2019-08-24",
"vDeducao": 1,
"vOutro": 1,
"vDescIncond": 1,
"vDescCond": 1,
"vISSRet": 1,
"cRegTrib": 0
},
"retTrib": {"vRetPIS": 1,
"vRetCOFINS": 1,
"vRetCSLL": 1,
"vBCIRRF": 1,
"vIRRF": 1,
"vBCRetPrev": 1,
"vRetPrev": 1
},
"ISTot": {"vIS": 0
},
"IBSCBSTot": {"vBCIBSCBS": 0,
"gIBS": {"gIBSUF": {"vDif": null,
"vDevTrib": null,
"vIBSUF": null
},
"gIBSMun": {"vDif": null,
"vDevTrib": null,
"vIBSMun": null
},
"vIBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gCBS": {"vDif": 0,
"vDevTrib": 0,
"vCBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gMono": {"vIBSMono": 0,
"vCBSMono": 0,
"vIBSMonoReten": 0,
"vCBSMonoReten": 0,
"vIBSMonoRet": 0,
"vCBSMonoRet": 0
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"IE": "string",
"xEnder": "string",
"xMun": "string",
"UF": "string"
},
"retTransp": {"vServ": 0,
"vBCRet": 0,
"pICMSRet": 0,
"vICMSRet": 0,
"CFOP": "string",
"cMunFG": "string"
},
"veicTransp": {"placa": "string",
"UF": "string",
"RNTC": "string"
},
"reboque": [{"placa": "string",
"UF": "string",
"RNTC": "string"
}
],
"vagao": "string",
"balsa": "string",
"vol": [{"qVol": 0,
"esp": "string",
"marca": "string",
"nVol": "string",
"pesoL": 0,
"pesoB": 0,
"lacres": [null
]
}
]
},
"cobr": {"fat": {"nFat": "string",
"vOrig": 0,
"vDesc": 0,
"vLiq": 0
},
"dup": [{"nDup": "string",
"dVenc": "2019-08-24",
"vDup": 1
}
]
},
"pag": {"detPag": [{"indPag": 0,
"tPag": "string",
"xPag": "string",
"vPag": 0,
"dPag": "2019-08-24",
"CNPJPag": "string",
"UFPag": "string",
"card": {"tpIntegra": null,
"CNPJ": null,
"tBand": null,
"cAut": null,
"CNPJReceb": null,
"idTermPag": null
}
}
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsFisco": [{"xCampo": "string",
"xTexto": "string"
}
],
"procRef": [{"nProc": "string",
"indProc": 0,
"tpAto": "string"
}
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [{"dia": 1,
"qtde": 0
}
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [{"xDed": "string",
"vDed": 0
}
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [{"nReceituario": "string",
"CPFRespTec": "string"
}
],
"guiaTransito": {"tpGuia": 0,
"UFGuia": "string",
"serieGuia": "string",
"nGuia": "string"
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": "string",
"RSAKeyValue": {"Modulus": "string",
"Exponent": "string"
}
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}

Sincroniza dados na NFC-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da NFC-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

Sincronizar uma nota que se encontra com o status erro na API, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
Sincronizar uma nota que se encontra com o status autorizadona API, mas está cancelada na SEFAZ.
Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota que porventura não tenham sido feitos a partir da API.

Informações adicionais:

Consumo: 1 unidade por evento sincronizado ou requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFC-e gerado pela API.

Responses

Response Schema: application/json

status	string Enum: "pendente" "sincronizado" "erro" Situação atual da sincronização.
codigo_status	integer Código da situação atual do DF-e.
motivo_status	string Descrição literal da situação atual do DF-e.
data_recebimento	string <date-time> Data e hora de processamento.
chave	string Chave de Acesso do DF-e consultado.

Response samples

Content type

application/json

{"status": "pendente",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"chave": "string"
}

NFCom

Nota Fiscal Fatura de Serviço de Comunicação Eletrônica.

Baixar PDF do DANFE-COM

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerado pela API.

query Parameters

logotipo

boolean

Default: false

Imprime o documento com logotipo, desde que esteja cadastrado na empresa.

Responses

Response Schema: /

string <binary>

Baixar XML da NFCom

Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerada pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da NFCom processada

Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz nfcomProc).

O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /nfcom/{id}/xml/nota.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerada pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerada pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do Protocolo da SEFAZ

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerada pela API.

Responses

Response Schema: /

string <binary>

Cancelar uma NFCom autorizada

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerada pela API.

Request Body schema: application/json

justificativa

string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"justificativa": "string"
}

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

A API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ.

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF/CNPJ do emitente. Utilize o valor sem máscara.
autorizador	string Ambiente Autorizador. Autorizadores disponíveis: `SVRS`. Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response Schema: application/json

autorizador	string Enum: "AM" "BA" "CE" "GO" "MG" "MS" "MT" "PE" "PR" "RS" "SP" "SVAN" "SVRS" "SVCAN" "SVCRS" "AN" "SVSP" "SVCSP" SEFAZ autorizadora responsável.
ambiente	string Enum: "homologacao" "producao" Identificação do Ambiente.
data_hora_consulta	string <date-time> Data e hora da consulta.
codigo_status	integer Código do status da mensagem enviada.
motivo_status	string Descrição literal do status do serviço solicitado.
tempo_medio_resposta	integer or null Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.
data_hora_retorno	string or null <date-time> Data e hora prevista para o retorno dos serviços prestados.

Response samples

Content type

application/json

{"autorizador": "AM",
"ambiente": "homologacao",
"data_hora_consulta": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"tempo_medio_resposta": 0,
"data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar NFCom

Consulta os detalhes de uma NFCom já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de NFCom e a API irá retornar as informações da NFCom correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerada pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Consultar o cancelamento da NFCom

Authorizations:

oauth2

path Parameters

required

string

ID único da NFCom gerada pela API.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Emitir NFCom

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (NfcomSefazInfNFCom) Informações da NFCom.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infNFCom": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"tpAmb": 0,
"mod": 0,
"serie": 0,
"nNF": 1,
"cNF": "string",
"cDV": 0,
"dhEmi": "2019-08-24T14:15:22Z",
"tpEmis": 0,
"nSiteAutoriz": 0,
"cMunFG": "string",
"finNFCom": 0,
"tpFat": 0,
"verProc": "string",
"indPrePago": 0,
"indCessaoMeiosRede": 0,
"indNotaEntrada": 0,
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"tpPagAnt": 0
},
"emit": {"CNPJ": "string",
"IE": "string",
"IEUFDest": "string",
"CRT": 0,
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"fone": "string",
"email": "string"
},
"ISUFEmit": "stringst"
},
"dest": {"xNome": "string",
"CNPJ": "string",
"CPF": "string",
"idOutros": "string",
"indIEDest": 0,
"IE": "string",
"IM": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string"
}
},
"assinante": {"iCodAssinante": "string",
"tpAssinante": 0,
"tpServUtil": 0,
"nContrato": "string",
"dContratoIni": "2019-08-24",
"dContratoFim": "2019-08-24",
"NroTermPrinc": "string",
"cUFPrinc": 0,
"NroTermAdic": "string",
"cUFAdic": 0
},
"gSub": {"chNFCom": "string",
"gNF": {"CNPJ": "string",
"mod": 0,
"serie": "str",
"nNF": 1,
"CompetEmis": "string",
"hash115": "string"
},
"motSub": "st"
},
"gCofat": {"chNFComLocal": "string",
"gNF": {"CNPJ": "string",
"mod": 0,
"serie": "str",
"nNF": 1,
"CompetEmis": "string",
"hash115": "string"
}
},
"det": [{"nItem": 1,
"chNFComAnt": "string",
"nItemAnt": "string",
"indNFComAntPapelFatCentral": 0,
"prod": {"cProd": "string",
"xProd": "string",
"cClass": "strings",
"CFOP": "string",
"CNPJLD": "string",
"uMed": 0,
"qFaturada": 0,
"vItem": 0,
"vDesc": 0,
"vOutro": 0,
"vProd": 0,
"dExpiracao": "2019-08-24",
"indDevolucao": 0,
"CNPJCobrTerc": "string",
"gPagAntecipado": {"chDFePagAnt": null,
"nItemPagAnt": null
}
},
"imposto": {"ICMS00": {"CST": null,
"vBC": null,
"pICMS": null,
"vICMS": null,
"pFCP": null,
"vFCP": null
},
"ICMS20": {"CST": null,
"pRedBC": null,
"vBC": null,
"pICMS": null,
"vICMS": null,
"vICMSDeson": null,
"cBenef": null,
"pFCP": null,
"vFCP": null
},
"ICMS40": {"CST": null,
"vICMSDeson": null,
"cBenef": null
},
"ICMS51": {"CST": null,
"vICMSDeson": null,
"cBenef": null
},
"ICMS90": {"CST": null,
"vBC": null,
"pICMS": null,
"vICMS": null,
"vICMSDeson": null,
"cBenef": null,
"pFCP": null,
"vFCP": null
},
"ICMSSN": {"CST": null,
"indSN": null
},
"ICMSUFDest": [null
],
"indSemCST": 0,
"PIS": {"CST": null,
"vBC": null,
"pPIS": null,
"vPIS": null
},
"COFINS": {"CST": null,
"vBC": null,
"pCOFINS": null,
"vCOFINS": null
},
"FUST": {"vBC": null,
"pFUST": null,
"vFUST": null
},
"FUNTTEL": {"vBC": null,
"pFUNTTEL": null,
"vFUNTTEL": null
},
"retTrib": {"vRetPIS": null,
"vRetCofins": null,
"vRetCSLL": null,
"vBCIRRF": null,
"vIRRF": null
},
"IBSCBS": {"CST": null,
"cClassTrib": null,
"indDoacao": null,
"gIBSCBS": null,
"gEstornoCred": null
}
},
"gProcRef": {"vItem": 0,
"qFaturada": 0,
"vProd": 0,
"vDesc": 0,
"vOutro": 0,
"indDevolucao": 0,
"vBC": 0,
"pICMS": 0,
"vICMS": 0,
"vPIS": 0,
"vCOFINS": 0,
"vFCP": 0,
"gProc": [null
]
},
"gRessarc": {"tpRessarc": 0,
"dRef": "2019-08-24",
"nProcesso": "string",
"nProtReclama": "string",
"xObs": "stringstringstr"
},
"infAdProd": "string"
}
],
"pgtoVinc": {"pgto": [{"nPag": "string",
"idTransacao": "string",
"tpMeioPgto": "string",
"CNPJReceb": "string",
"CNPJBasePSP": "string"
}
]
},
"total": {"vProd": 0,
"ICMSTot": {"vBC": 0,
"vICMS": 0,
"vICMSDeson": 0,
"vFCP": 0
},
"vCOFINS": 0,
"vPIS": 0,
"vFUNTTEL": 0,
"vFUST": 0,
"vRetTribTot": {"vRetPIS": 0,
"vRetCofins": 0,
"vRetCSLL": 0,
"vIRRF": 0
},
"vDesc": 0,
"vOutro": 0,
"vNF": 0,
"IBSCBSTot": {"vBCIBSCBS": 0,
"gIBS": {"gIBSUF": {"vDif": null,
"vDevTrib": null,
"vIBSUF": null
},
"gIBSMun": {"vDif": null,
"vDevTrib": null,
"vIBSMun": null
},
"vIBS": 0
},
"gCBS": {"vDif": 0,
"vDevTrib": 0,
"vCBS": 0
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vTotDFe": 0
},
"gFidelidade": {"qtdSaldoPts": "string",
"dRefSaldoPts": "2019-08-24",
"qtdPtsResg": "string",
"dRefResgPts": "2019-08-24"
},
"gFat": {"CompetFat": "string",
"dVencFat": "2019-08-24",
"dPerUsoIni": "2019-08-24",
"dPerUsoFim": "2019-08-24",
"codBarras": "string",
"codDebAuto": "string",
"codBanco": "strin",
"codAgencia": "string",
"enderCorresp": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"CEP": "string",
"UF": "string",
"fone": "string",
"email": "string"
},
"gPIX": {"urlQRCodePIX": "string"
}
},
"gFatCentral": {"CNPJ": "string",
"cUF": 0
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"infAdic": {"infAdFisco": "string",
"infCpl": ["string"
]
},
"gRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
}
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Listar NFCom

Retorna a lista de NFCom de acordo com os critérios de busca utilizados. As NFCom são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Dfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

NF-e

Nota Fiscal Eletrônica.

Baixar PDF da carta de correção

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF da inutilização

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do cancelamento

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar PDF do DANFE

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
nome_fantasia	boolean Default: false Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
formato	string Default: "padrao" Formato de impressão do DANFE. Valores disponíveis: `padrao`: será utilizado o formato definido no XML da NF-e (tag "tpImp"); `retrato`: tamanho A4 em modo retrato; `paisagem`: tamanho A4 em modo paisagem; `simplificado`: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11); `etiqueta`: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004).
mensagem_rodape	string <= 120 characters Default: "" Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"`
canhoto	boolean Default: true Imprime o documento com o bloco de canhoto.
qrcode_lateral	boolean Default: false Imprime o QR Code na lateral do DANFE Simplificado Tipo 2. Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6) e disponível apenas para 80 milímetros de largura.
largura	integer [ 56 .. 80 ] Default: 80 Largura do DANFE Simplificado Tipo 2 (em milímetros). Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6). A NT 2026.003 exige no mínimo 56 mm.
margem	string Default: "2" Define as margens do DANFE Simplificado Tipo 2 (em milímetros), no mesmo formato do parâmetro `margem` do PDF da NFC-e. Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6). Margens laterais menores que 2 mm são ajustadas para 2 mm, o mínimo da NT 2026.003.

Responses

Response Schema: /

string <binary>

Baixar PDF do evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da carta de correção

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da inutilização

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da NF-e

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ.

O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da NF-e processada

Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz nfeProc).

O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint GET /nfe/{id}/xml/nota.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do evento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do Protocolo da SEFAZ

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: /

string <binary>

Cancelar uma NF-e autorizada

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Request Body schema: application/json

justificativa

string

Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"justificativa": "string"
}

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consulta do Status do Serviço na SEFAZ Autorizadora

Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF/CNPJ do emitente. Utilize o valor sem máscara.
autorizador	string Ambiente Autorizador. Autorizadores disponíveis: `AM`, `BA`, `GO`, `MG`, `MS`, `MT`, `PE`, `PR`, `RS`, `SP`, `SVAN`, `SVRS`, `SVCAN`, `SVCRS`, `AN`. Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.

Responses

Response Schema: application/json

autorizador	string Enum: "AM" "BA" "CE" "GO" "MG" "MS" "MT" "PE" "PR" "RS" "SP" "SVAN" "SVRS" "SVCAN" "SVCRS" "AN" "SVSP" "SVCSP" SEFAZ autorizadora responsável.
ambiente	string Enum: "homologacao" "producao" Identificação do Ambiente.
data_hora_consulta	string <date-time> Data e hora da consulta.
codigo_status	integer Código do status da mensagem enviada.
motivo_status	string Descrição literal do status do serviço solicitado.
tempo_medio_resposta	integer or null Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.
data_hora_retorno	string or null <date-time> Data e hora prevista para o retorno dos serviços prestados.

Response samples

Content type

application/json

{"autorizador": "AM",
"ambiente": "homologacao",
"data_hora_consulta": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"tempo_medio_resposta": 0,
"data_hora_retorno": "2019-08-24T14:15:22Z"
}

Consultar a inutilização de sequência de numeração

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: application/json

cnpj	string
ano	integer
modelo	integer
serie	integer
numero_inicial	integer
numero_final	integer
justificativa	string
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"cnpj": "string",
"ano": 0,
"modelo": 0,
"serie": 0,
"numero_inicial": 0,
"numero_final": 0,
"justificativa": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar a solicitação de correção da NF-e

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: application/json

correcao	string Correção a ser considerada.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"correcao": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar contribuinte

Consulta o Cadastro Centralizado de Contribuintes (CCC) do ICMS da unidade federada.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

query Parameters

cpf_cnpj required	string CPF ou CNPJ da empresa. Utilize o valor sem máscara.
uf	string Sigla da UF consultada. Utilize `SU` para SUFRAMA. Caso não seja informada, será utilizada a UF da empresa.
argumento required	string Argumento de pesquisa. Valores válidos: `CNPJ` `CPF` `IE`
documento required	string Documento a ser consultado (CNPJ, CPF ou Inscrição Estadual).

Responses

Response Schema: application/json

codigo_status required	integer or null [ 0 .. 999 ] Código do status da mensagem enviada.
motivo_status required	string or null [ 1 .. 255 ] characters Descrição literal do status do serviço solicitado.
uf required	string or null sigla da UF consultada, utilizar SU para SUFRAMA.
ie	string or null Inscrição Estadual do contribuinte.
cnpj	string or null CNPJ do contribuinte.
cpf	string or null CPF do contribuinte.
data_consulta required	string or null <date-time> Data da Consulta.
uf_atendimento required	integer or null código da UF de atendimento.
	Array of objects (DfeContribuinteInfCad)

Response samples

Content type

application/json

{"codigo_status": 0,
"motivo_status": "string",
"uf": "string",
"ie": "string",
"cnpj": "string",
"cpf": "string",
"data_consulta": "2019-08-24T14:15:22Z",
"uf_atendimento": 0,
"informacoes_cadastrais": [{"ie": "string",
"cnpj": "string",
"cpf": "string",
"uf": "string",
"situacao_cadastral": 0,
"indicador_nfe": 0,
"indicador_cte": 0,
"nome_razao_social": "string",
"nome_fantasia": "string",
"regime_apuracao_icms": "string",
"cnae": "string",
"data_inicio_atividade": "2019-08-24",
"data_situacao_cadastral": "2019-08-24",
"data_fim_atividade": "2019-08-24",
"ie_unica": "string",
"ie_atual": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"nome_municipio": "string",
"uf": "string",
"cep": "string",
"codigo_pais": "string",
"pais": "string",
"fone": "string"
}
}
]
}

Consultar evento

Authorizations:

oauth2

path Parameters

required

string

ID único do evento gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Consultar lote de NF-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único do lote gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
created_at	string <date-time>
status	string Enum: "pendente" "processado" "erro"
ambiente	string Enum: "homologacao" "producao"
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote	string or null
	object (DfeRecibo)
	Array of objects (Dfe)

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Consultar NF-e

Consulta os detalhes de uma NF-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de notas e a API irá retornar as informações da nota correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Consultar o cancelamento da NF-e

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: application/json

justificativa	string Justificativa do cancelamento.
chave_substituta	string Chave de acesso da NFC-e substituta. Preenchida apenas no cancelamento por substituição (evento 110112).
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Response samples

Content type

application/json

{"justificativa": "string",
"chave_substituta": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Emitir lote de NF-e

Informações adicionais:

Consumo: 1 unidade por NF-e.

Authorizations:

oauth2

Request Body schema: application/json
required

required	Array of objects (NfePedidoEmissao) [ 1 .. 50 ] items
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string <= 50 characters Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote required	string

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
created_at	string <date-time>
status	string Enum: "pendente" "processado" "erro"
ambiente	string Enum: "homologacao" "producao"
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
id_lote	string or null
	object (DfeRecibo)
	Array of objects (Dfe)

Request samples

Payload

Content type

application/json

{"documentos": [{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [null
],
"gCompraGov": {"tpEnteGov": null,
"pRedutor": null,
"tpOperGov": null,
"refDFeAnt": [ ]
},
"gPagAntecipado": {"refNFe": [ ]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": null,
"nro": null,
"xCpl": null,
"xBairro": null,
"cMun": null,
"xMun": null,
"UF": null,
"CEP": null,
"cPais": null,
"xPais": null,
"fone": null
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": null,
"nro": null,
"xCpl": null,
"xBairro": null,
"cMun": null,
"xMun": null,
"UF": null,
"CEP": null,
"cPais": null,
"xPais": null,
"fone": null
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": null,
"CPF": null
}
],
"det": [{"nItem": null,
"prod": null,
"imposto": null,
"impostoDevol": null,
"infAdProd": null,
"obsItem": null,
"vItem": null,
"DFeReferenciado": null
}
],
"total": {"ICMSTot": {"vBC": null,
"vICMS": null,
"vICMSDeson": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null,
"vFCP": null,
"vBCST": null,
"vST": null,
"vFCPST": null,
"vFCPSTRet": null,
"qBCMono": null,
"vICMSMono": null,
"qBCMonoReten": null,
"vICMSMonoReten": null,
"qBCMonoRet": null,
"vICMSMonoRet": null,
"vProd": null,
"vFrete": null,
"vSeg": null,
"vDesc": null,
"vII": null,
"vIPI": null,
"vIPIDevol": null,
"vPIS": null,
"vCOFINS": null,
"vOutro": null,
"vNF": null,
"vTotTrib": null
},
"ISSQNtot": {"vServ": null,
"vBC": null,
"vISS": null,
"vPIS": null,
"vCOFINS": null,
"dCompet": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"cRegTrib": null
},
"retTrib": {"vRetPIS": null,
"vRetCOFINS": null,
"vRetCSLL": null,
"vBCIRRF": null,
"vIRRF": null,
"vBCRetPrev": null,
"vRetPrev": null
},
"ISTot": {"vIS": null
},
"IBSCBSTot": {"vBCIBSCBS": null,
"gIBS": null,
"gCBS": null,
"gMono": null,
"gEstornoCred": null
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": null,
"CPF": null,
"xNome": null,
"IE": null,
"xEnder": null,
"xMun": null,
"UF": null
},
"retTransp": {"vServ": null,
"vBCRet": null,
"pICMSRet": null,
"vICMSRet": null,
"CFOP": null,
"cMunFG": null
},
"veicTransp": {"placa": null,
"UF": null,
"RNTC": null
},
"reboque": [null
],
"vagao": "string",
"balsa": "string",
"vol": [null
]
},
"cobr": {"fat": {"nFat": null,
"vOrig": null,
"vDesc": null,
"vLiq": null
},
"dup": [null
]
},
"pag": {"detPag": [null
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [null
],
"obsFisco": [null
],
"procRef": [null
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [null
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [null
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [null
],
"guiaTransito": {"tpGuia": null,
"UFGuia": null,
"serieGuia": null,
"nGuia": null
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": null,
"RSAKeyValue": null
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}
],
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string"
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Emitir NF-e

Este endpoint permite a emissão de Notas Fiscais Eletrônicas (NF-e). A solicitação deve ser feita enviando os dados necessários para a emissão de uma NF-e.

A estrutura do JSON utilizado na solicitação segue a hierarquia e nomenclatura de campos definidos no Manual de Orientação ao Contribuinte (MOC). Esta conformidade visa facilitar a integração de novos usuários que já possuem familiaridade com o padrão, além de permitir a resolução de dúvidas diretamente no MOC, com um profissional de contabilidade habilitado ou em outras fontes confiáveis que tratam do mesmo assunto.

Comportamento Assíncrono

A resposta desse endpoint inclui a propriedade status no JSON. Caso o valor retornado seja pendente, significa que a solicitação está sendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá adotar um fluxo que consiste em requisitar periodicamente o endpoint Consultar NF-e até que seja retornado um status indicando o fim da emissão.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (NfeSefazInfNFe) Informações da Nota Fiscal eletrônica.
	object (NfeSefazInfNFeSupl) Informações suplementares Nota Fiscal.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este documento.
ambiente	string Enum: "homologacao" "producao"
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
status	string Enum: "pendente" "autorizado" "rejeitado" "denegado" "encerrado" "cancelado" "erro" `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento. `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status. `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento. `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e. `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).
referencia	string or null Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
data_emissao	string <date-time>
modelo	integer
serie	integer
numero	integer
tipo_emissao	integer
valor_total	number
chave	string Chave de acesso do DF-e.
	object (DfeAutorizacao)

Request samples

Payload

Content type

application/json

{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [{"refNFe": "string",
"refNFeSig": "string",
"refNF": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"mod": null,
"serie": null,
"nNF": null
},
"refNFP": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"CPF": null,
"IE": null,
"mod": null,
"serie": null,
"nNF": null
},
"refCTe": "string",
"refECF": {"mod": null,
"nECF": null,
"nCOO": null
}
}
],
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"gPagAntecipado": {"refNFe": ["string"
]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"det": [{"nItem": 1,
"prod": {"cProd": "string",
"cEAN": "string",
"cBarra": "string",
"xProd": "string",
"NCM": "string",
"NVE": [null
],
"CEST": "string",
"indEscala": "string",
"CNPJFab": "string",
"cBenef": "string",
"gCred": [null
],
"tpCredPresIBSZFM": 0,
"EXTIPI": "string",
"CFOP": "string",
"uCom": "string",
"qCom": 0,
"vUnCom": 0,
"vProd": 0,
"cEANTrib": "string",
"cBarraTrib": "string",
"uTrib": "string",
"qTrib": 0,
"vUnTrib": 0,
"vFrete": 1,
"vSeg": 1,
"vDesc": 1,
"vOutro": 1,
"indTot": 0,
"indBemMovelUsado": 0,
"DI": [null
],
"detExport": [null
],
"xPed": "string",
"nItemPed": 0,
"nFCI": "string",
"rastro": [null
],
"infProdNFF": {"cProdFisco": null,
"cOperNFF": null
},
"infProdEmb": {"xEmb": null,
"qVolEmb": null,
"uEmb": null
},
"veicProd": {"tpOp": null,
"chassi": null,
"cCor": null,
"xCor": null,
"pot": null,
"cilin": null,
"pesoL": null,
"pesoB": null,
"nSerie": null,
"tpComb": null,
"nMotor": null,
"CMT": null,
"dist": null,
"anoMod": null,
"anoFab": null,
"tpPint": null,
"tpVeic": null,
"espVeic": null,
"VIN": null,
"condVeic": null,
"cMod": null,
"cCorDENATRAN": null,
"lota": null,
"tpRest": null
},
"med": {"cProdANVISA": null,
"xMotivoIsencao": null,
"vPMC": null
},
"arma": [null
],
"comb": {"cProdANP": null,
"descANP": null,
"pGLP": null,
"pGNn": null,
"pGNi": null,
"vPart": null,
"CODIF": null,
"qTemp": null,
"UFCons": null,
"CIDE": null,
"encerrante": null,
"pBio": null,
"origComb": [ ]
},
"nRECOPI": "string"
},
"imposto": {"vTotTrib": 0,
"ICMS": {"ICMS00": null,
"ICMS02": null,
"ICMS10": null,
"ICMS15": null,
"ICMS20": null,
"ICMS30": null,
"ICMS40": null,
"ICMS51": null,
"ICMS53": null,
"ICMS60": null,
"ICMS61": null,
"ICMS70": null,
"ICMS90": null,
"ICMSPart": null,
"ICMSST": null,
"ICMSSN101": null,
"ICMSSN102": null,
"ICMSSN201": null,
"ICMSSN202": null,
"ICMSSN500": null,
"ICMSSN900": null
},
"IPI": {"CNPJProd": null,
"cSelo": null,
"qSelo": null,
"cEnq": null,
"IPITrib": null,
"IPINT": null
},
"II": {"vBC": null,
"vDespAdu": null,
"vII": null,
"vIOF": null
},
"ISSQN": {"vBC": null,
"vAliq": null,
"vISSQN": null,
"cMunFG": null,
"cListServ": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"indISS": null,
"cServico": null,
"cMun": null,
"cPais": null,
"nProcesso": null,
"indIncentivo": null
},
"PIS": {"PISAliq": null,
"PISQtde": null,
"PISNT": null,
"PISOutr": null
},
"PISST": {"vBC": null,
"pPIS": null,
"qBCProd": null,
"vAliqProd": null,
"vPIS": null,
"indSomaPISST": null
},
"COFINS": {"COFINSAliq": null,
"COFINSQtde": null,
"COFINSNT": null,
"COFINSOutr": null
},
"COFINSST": {"vBC": null,
"pCOFINS": null,
"qBCProd": null,
"vAliqProd": null,
"vCOFINS": null,
"indSomaCOFINSST": null
},
"ICMSUFDest": {"vBCUFDest": null,
"vBCFCPUFDest": null,
"pFCPUFDest": null,
"pICMSUFDest": null,
"pICMSInter": null,
"pICMSInterPart": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null
},
"IS": {"CSTIS": null,
"cClassTribIS": null,
"vBCIS": null,
"pIS": null,
"adRemIS": null,
"uTrib": null,
"qTrib": null,
"vIS": null
},
"IBSCBS": {"CST": null,
"cClassTrib": null,
"indDoacao": null,
"gIBSCBS": null,
"gIBSCBSMono": null,
"gTransfCred": null,
"gAjusteCompet": null,
"gEstornoCred": null,
"gCredPresOper": null,
"gCredPresIBSZFM": null
}
},
"impostoDevol": {"pDevol": 0,
"IPI": {"vIPIDevol": null
}
},
"infAdProd": "string",
"obsItem": {"obsCont": {"xCampo": null,
"xTexto": null
},
"obsFisco": {"xCampo": null,
"xTexto": null
}
},
"vItem": 0,
"DFeReferenciado": {"chaveAcesso": "string",
"nItem": 1
}
}
],
"total": {"ICMSTot": {"vBC": 0,
"vICMS": 0,
"vICMSDeson": 0,
"vFCPUFDest": 0,
"vICMSUFDest": 0,
"vICMSUFRemet": 0,
"vFCP": 0,
"vBCST": 0,
"vST": 0,
"vFCPST": 0,
"vFCPSTRet": 0,
"qBCMono": 0,
"vICMSMono": 0,
"qBCMonoReten": 0,
"vICMSMonoReten": 0,
"qBCMonoRet": 0,
"vICMSMonoRet": 0,
"vProd": 0,
"vFrete": 0,
"vSeg": 0,
"vDesc": 0,
"vII": 0,
"vIPI": 0,
"vIPIDevol": 0,
"vPIS": 0,
"vCOFINS": 0,
"vOutro": 0,
"vNF": 0,
"vTotTrib": 0
},
"ISSQNtot": {"vServ": 1,
"vBC": 1,
"vISS": 1,
"vPIS": 1,
"vCOFINS": 1,
"dCompet": "2019-08-24",
"vDeducao": 1,
"vOutro": 1,
"vDescIncond": 1,
"vDescCond": 1,
"vISSRet": 1,
"cRegTrib": 0
},
"retTrib": {"vRetPIS": 1,
"vRetCOFINS": 1,
"vRetCSLL": 1,
"vBCIRRF": 1,
"vIRRF": 1,
"vBCRetPrev": 1,
"vRetPrev": 1
},
"ISTot": {"vIS": 0
},
"IBSCBSTot": {"vBCIBSCBS": 0,
"gIBS": {"gIBSUF": {"vDif": null,
"vDevTrib": null,
"vIBSUF": null
},
"gIBSMun": {"vDif": null,
"vDevTrib": null,
"vIBSMun": null
},
"vIBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gCBS": {"vDif": 0,
"vDevTrib": 0,
"vCBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gMono": {"vIBSMono": 0,
"vCBSMono": 0,
"vIBSMonoReten": 0,
"vCBSMonoReten": 0,
"vIBSMonoRet": 0,
"vCBSMonoRet": 0
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"IE": "string",
"xEnder": "string",
"xMun": "string",
"UF": "string"
},
"retTransp": {"vServ": 0,
"vBCRet": 0,
"pICMSRet": 0,
"vICMSRet": 0,
"CFOP": "string",
"cMunFG": "string"
},
"veicTransp": {"placa": "string",
"UF": "string",
"RNTC": "string"
},
"reboque": [{"placa": "string",
"UF": "string",
"RNTC": "string"
}
],
"vagao": "string",
"balsa": "string",
"vol": [{"qVol": 0,
"esp": "string",
"marca": "string",
"nVol": "string",
"pesoL": 0,
"pesoB": 0,
"lacres": [null
]
}
]
},
"cobr": {"fat": {"nFat": "string",
"vOrig": 0,
"vDesc": 0,
"vLiq": 0
},
"dup": [{"nDup": "string",
"dVenc": "2019-08-24",
"vDup": 1
}
]
},
"pag": {"detPag": [{"indPag": 0,
"tPag": "string",
"xPag": "string",
"vPag": 0,
"dPag": "2019-08-24",
"CNPJPag": "string",
"UFPag": "string",
"card": {"tpIntegra": null,
"CNPJ": null,
"tBand": null,
"cAut": null,
"CNPJReceb": null,
"idTermPag": null
}
}
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsFisco": [{"xCampo": "string",
"xTexto": "string"
}
],
"procRef": [{"nProc": "string",
"indProc": 0,
"tpAto": "string"
}
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [{"dia": 1,
"qtde": 0
}
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [{"xDed": "string",
"vDed": 0
}
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [{"nReceituario": "string",
"CPFRespTec": "string"
}
],
"guiaTransito": {"tpGuia": 0,
"UFGuia": "string",
"serieGuia": "string",
"nGuia": "string"
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": "string",
"RSAKeyValue": {"Modulus": "string",
"Exponent": "string"
}
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}

Response samples

Content type

application/json

{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}

Enviar e-mail

Envia o XML e PDF da nota via email.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
nome_fantasia	boolean Default: false Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
formato	string Default: "padrao" Formato de impressão do DANFE. Valores disponíveis: `padrao`: será utilizado o formato definido no XML da NF-e (tag "tpImp"); `retrato`: tamanho A4 em modo retrato; `paisagem`: tamanho A4 em modo paisagem; `simplificado`: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11); `etiqueta`: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004).
mensagem_rodape	string <= 120 characters Default: "" Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"`
canhoto	boolean Default: true Imprime o documento com o bloco de canhoto.
qrcode_lateral	boolean Default: false Imprime o QR Code na lateral do DANFE Simplificado Tipo 2. Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6) e disponível apenas para 80 milímetros de largura.
largura	integer [ 56 .. 80 ] Default: 80 Largura do DANFE Simplificado Tipo 2 (em milímetros). Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6). A NT 2026.003 exige no mínimo 56 mm.
margem	string Default: "2" Define as margens do DANFE Simplificado Tipo 2 (em milímetros), no mesmo formato do parâmetro `margem` do PDF da NFC-e. Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6). Margens laterais menores que 2 mm são ajustadas para 2 mm, o mínimo da NT 2026.003.

Request Body schema: application/json

Array of objects (EnderecoEmail) <= 10 items

Lista de endereços de email para envio dos arquivos.

Caso nenhum email seja informado, será utilizado o email do destinatário do documento fiscal.

Array (<= 10 items)

required

string

Email do destinatário.

Responses

Response Schema: application/json

id required	string ID único gerado pela API para este email. Utilize-o no endpoint de consulta de email para obter informações detalhadas sobre o envio do email e rastrear todos os eventos relacionados, como envio, entrega, falhas e outros eventos relevantes.
status	string Enum: "pending" "sending" "sent" "delivered" "delivery_delayed" "bounced" "complained" "rejected" "cancelled" "failed"
status_message	string or null

Request samples

Payload

Content type

application/json

{"destinatarios": [{"email": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"status": "pending",
"status_message": "string"
}

Inutilizar uma sequência de numeração de NF-e

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
cnpj required	string CNPJ do emitente.
ano required	integer Ano de inutilização da numeração.
serie required	integer [ 0 .. 999 ] Série da NF-e.
numero_inicial required	integer [ 1 .. 999999999 ] Número da NF-e inicial.
numero_final required	integer [ 1 .. 999999999 ] Número da NF-e final.
justificativa required	string [ 15 .. 255 ] characters Justificativa do pedido de inutilização.

Responses

Response Schema: application/json

cnpj	string
ano	integer
modelo	integer
serie	integer
numero_inicial	integer
numero_final	integer
justificativa	string
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"ambiente": "homologacao",
"cnpj": "string",
"ano": 0,
"serie": 0,
"numero_inicial": 1,
"numero_final": 1,
"justificativa": "stringstringstr"
}

Response samples

Content type

application/json

{"cnpj": "string",
"ano": 0,
"modelo": 0,
"serie": 0,
"numero_inicial": 0,
"numero_final": 0,
"justificativa": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

Listar eventos

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
dfe_id required	string ID único gerado pela API para o documento fiscal.

Responses

Response Schema: application/json

@count	integer
	Array of objects (DfeEvento)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
]
}

Listar lotes de NF-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao

Responses

Response Schema: application/json

@count	integer
	Array of objects (DfeLote)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"ambiente": "homologacao",
"referencia": "string",
"id_lote": "string",
"recibo": {"numero": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_mensagem": 0,
"mensagem": "string"
},
"documentos": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": null,
"id": null,
"ambiente": null,
"status": null,
"autor": null,
"chave_acesso": null,
"data_evento": null,
"numero_sequencial": null,
"data_recebimento": null,
"codigo_status": null,
"motivo_status": null,
"numero_protocolo": null,
"codigo_mensagem": null,
"mensagem": null,
"tipo_evento": null
}
}
]
}
]
}

Listar NF-e

Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Dfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"ambiente": "homologacao",
"created_at": "2019-08-24T14:15:22Z",
"status": "pendente",
"referencia": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"modelo": 0,
"serie": 0,
"numero": 0,
"tipo_emissao": 0,
"valor_total": 0,
"chave": "string",
"autorizacao": {"digest_value": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}
}
]
}

Prévia do PDF do DANFE

Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do DANFE.

Os dados de entrada são os mesmos do endpoint de emissão de NF-e (POST /nfe).

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
nome_fantasia	boolean Default: false Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
formato	string Default: "padrao" Formato de impressão do DANFE. Valores disponíveis: `padrao`: será utilizado o formato definido no XML da NF-e (tag "tpImp"); `retrato`: tamanho A4 em modo retrato; `paisagem`: tamanho A4 em modo paisagem; `simplificado`: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11); `etiqueta`: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004).
mensagem_rodape	string <= 120 characters Default: "" Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"`
canhoto	boolean Default: true Imprime o documento com o bloco de canhoto.
qrcode_lateral	boolean Default: false Imprime o QR Code na lateral do DANFE Simplificado Tipo 2. Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6) e disponível apenas para 80 milímetros de largura.
largura	integer [ 56 .. 80 ] Default: 80 Largura do DANFE Simplificado Tipo 2 (em milímetros). Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6). A NT 2026.003 exige no mínimo 56 mm.
margem	string Default: "2" Define as margens do DANFE Simplificado Tipo 2 (em milímetros), no mesmo formato do parâmetro `margem` do PDF da NFC-e. Aplicãvel apenas à NF-e com DANFE Simplificado Tipo 2 (`tpImp` = 6). Margens laterais menores que 2 mm são ajustadas para 2 mm, o mínimo da NT 2026.003.

Request Body schema: application/json
required

required	object (NfeSefazInfNFe) Informações da Nota Fiscal eletrônica.
	object (NfeSefazInfNFeSupl) Informações suplementares Nota Fiscal.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: /

string <binary>

Request samples

Payload

Content type

application/json

{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [{"refNFe": "string",
"refNFeSig": "string",
"refNF": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"mod": null,
"serie": null,
"nNF": null
},
"refNFP": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"CPF": null,
"IE": null,
"mod": null,
"serie": null,
"nNF": null
},
"refCTe": "string",
"refECF": {"mod": null,
"nECF": null,
"nCOO": null
}
}
],
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"gPagAntecipado": {"refNFe": ["string"
]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"det": [{"nItem": 1,
"prod": {"cProd": "string",
"cEAN": "string",
"cBarra": "string",
"xProd": "string",
"NCM": "string",
"NVE": [null
],
"CEST": "string",
"indEscala": "string",
"CNPJFab": "string",
"cBenef": "string",
"gCred": [null
],
"tpCredPresIBSZFM": 0,
"EXTIPI": "string",
"CFOP": "string",
"uCom": "string",
"qCom": 0,
"vUnCom": 0,
"vProd": 0,
"cEANTrib": "string",
"cBarraTrib": "string",
"uTrib": "string",
"qTrib": 0,
"vUnTrib": 0,
"vFrete": 1,
"vSeg": 1,
"vDesc": 1,
"vOutro": 1,
"indTot": 0,
"indBemMovelUsado": 0,
"DI": [null
],
"detExport": [null
],
"xPed": "string",
"nItemPed": 0,
"nFCI": "string",
"rastro": [null
],
"infProdNFF": {"cProdFisco": null,
"cOperNFF": null
},
"infProdEmb": {"xEmb": null,
"qVolEmb": null,
"uEmb": null
},
"veicProd": {"tpOp": null,
"chassi": null,
"cCor": null,
"xCor": null,
"pot": null,
"cilin": null,
"pesoL": null,
"pesoB": null,
"nSerie": null,
"tpComb": null,
"nMotor": null,
"CMT": null,
"dist": null,
"anoMod": null,
"anoFab": null,
"tpPint": null,
"tpVeic": null,
"espVeic": null,
"VIN": null,
"condVeic": null,
"cMod": null,
"cCorDENATRAN": null,
"lota": null,
"tpRest": null
},
"med": {"cProdANVISA": null,
"xMotivoIsencao": null,
"vPMC": null
},
"arma": [null
],
"comb": {"cProdANP": null,
"descANP": null,
"pGLP": null,
"pGNn": null,
"pGNi": null,
"vPart": null,
"CODIF": null,
"qTemp": null,
"UFCons": null,
"CIDE": null,
"encerrante": null,
"pBio": null,
"origComb": [ ]
},
"nRECOPI": "string"
},
"imposto": {"vTotTrib": 0,
"ICMS": {"ICMS00": null,
"ICMS02": null,
"ICMS10": null,
"ICMS15": null,
"ICMS20": null,
"ICMS30": null,
"ICMS40": null,
"ICMS51": null,
"ICMS53": null,
"ICMS60": null,
"ICMS61": null,
"ICMS70": null,
"ICMS90": null,
"ICMSPart": null,
"ICMSST": null,
"ICMSSN101": null,
"ICMSSN102": null,
"ICMSSN201": null,
"ICMSSN202": null,
"ICMSSN500": null,
"ICMSSN900": null
},
"IPI": {"CNPJProd": null,
"cSelo": null,
"qSelo": null,
"cEnq": null,
"IPITrib": null,
"IPINT": null
},
"II": {"vBC": null,
"vDespAdu": null,
"vII": null,
"vIOF": null
},
"ISSQN": {"vBC": null,
"vAliq": null,
"vISSQN": null,
"cMunFG": null,
"cListServ": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"indISS": null,
"cServico": null,
"cMun": null,
"cPais": null,
"nProcesso": null,
"indIncentivo": null
},
"PIS": {"PISAliq": null,
"PISQtde": null,
"PISNT": null,
"PISOutr": null
},
"PISST": {"vBC": null,
"pPIS": null,
"qBCProd": null,
"vAliqProd": null,
"vPIS": null,
"indSomaPISST": null
},
"COFINS": {"COFINSAliq": null,
"COFINSQtde": null,
"COFINSNT": null,
"COFINSOutr": null
},
"COFINSST": {"vBC": null,
"pCOFINS": null,
"qBCProd": null,
"vAliqProd": null,
"vCOFINS": null,
"indSomaCOFINSST": null
},
"ICMSUFDest": {"vBCUFDest": null,
"vBCFCPUFDest": null,
"pFCPUFDest": null,
"pICMSUFDest": null,
"pICMSInter": null,
"pICMSInterPart": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null
},
"IS": {"CSTIS": null,
"cClassTribIS": null,
"vBCIS": null,
"pIS": null,
"adRemIS": null,
"uTrib": null,
"qTrib": null,
"vIS": null
},
"IBSCBS": {"CST": null,
"cClassTrib": null,
"indDoacao": null,
"gIBSCBS": null,
"gIBSCBSMono": null,
"gTransfCred": null,
"gAjusteCompet": null,
"gEstornoCred": null,
"gCredPresOper": null,
"gCredPresIBSZFM": null
}
},
"impostoDevol": {"pDevol": 0,
"IPI": {"vIPIDevol": null
}
},
"infAdProd": "string",
"obsItem": {"obsCont": {"xCampo": null,
"xTexto": null
},
"obsFisco": {"xCampo": null,
"xTexto": null
}
},
"vItem": 0,
"DFeReferenciado": {"chaveAcesso": "string",
"nItem": 1
}
}
],
"total": {"ICMSTot": {"vBC": 0,
"vICMS": 0,
"vICMSDeson": 0,
"vFCPUFDest": 0,
"vICMSUFDest": 0,
"vICMSUFRemet": 0,
"vFCP": 0,
"vBCST": 0,
"vST": 0,
"vFCPST": 0,
"vFCPSTRet": 0,
"qBCMono": 0,
"vICMSMono": 0,
"qBCMonoReten": 0,
"vICMSMonoReten": 0,
"qBCMonoRet": 0,
"vICMSMonoRet": 0,
"vProd": 0,
"vFrete": 0,
"vSeg": 0,
"vDesc": 0,
"vII": 0,
"vIPI": 0,
"vIPIDevol": 0,
"vPIS": 0,
"vCOFINS": 0,
"vOutro": 0,
"vNF": 0,
"vTotTrib": 0
},
"ISSQNtot": {"vServ": 1,
"vBC": 1,
"vISS": 1,
"vPIS": 1,
"vCOFINS": 1,
"dCompet": "2019-08-24",
"vDeducao": 1,
"vOutro": 1,
"vDescIncond": 1,
"vDescCond": 1,
"vISSRet": 1,
"cRegTrib": 0
},
"retTrib": {"vRetPIS": 1,
"vRetCOFINS": 1,
"vRetCSLL": 1,
"vBCIRRF": 1,
"vIRRF": 1,
"vBCRetPrev": 1,
"vRetPrev": 1
},
"ISTot": {"vIS": 0
},
"IBSCBSTot": {"vBCIBSCBS": 0,
"gIBS": {"gIBSUF": {"vDif": null,
"vDevTrib": null,
"vIBSUF": null
},
"gIBSMun": {"vDif": null,
"vDevTrib": null,
"vIBSMun": null
},
"vIBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gCBS": {"vDif": 0,
"vDevTrib": 0,
"vCBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gMono": {"vIBSMono": 0,
"vCBSMono": 0,
"vIBSMonoReten": 0,
"vCBSMonoReten": 0,
"vIBSMonoRet": 0,
"vCBSMonoRet": 0
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"IE": "string",
"xEnder": "string",
"xMun": "string",
"UF": "string"
},
"retTransp": {"vServ": 0,
"vBCRet": 0,
"pICMSRet": 0,
"vICMSRet": 0,
"CFOP": "string",
"cMunFG": "string"
},
"veicTransp": {"placa": "string",
"UF": "string",
"RNTC": "string"
},
"reboque": [{"placa": "string",
"UF": "string",
"RNTC": "string"
}
],
"vagao": "string",
"balsa": "string",
"vol": [{"qVol": 0,
"esp": "string",
"marca": "string",
"nVol": "string",
"pesoL": 0,
"pesoB": 0,
"lacres": [null
]
}
]
},
"cobr": {"fat": {"nFat": "string",
"vOrig": 0,
"vDesc": 0,
"vLiq": 0
},
"dup": [{"nDup": "string",
"dVenc": "2019-08-24",
"vDup": 1
}
]
},
"pag": {"detPag": [{"indPag": 0,
"tPag": "string",
"xPag": "string",
"vPag": 0,
"dPag": "2019-08-24",
"CNPJPag": "string",
"UFPag": "string",
"card": {"tpIntegra": null,
"CNPJ": null,
"tBand": null,
"cAut": null,
"CNPJReceb": null,
"idTermPag": null
}
}
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsFisco": [{"xCampo": "string",
"xTexto": "string"
}
],
"procRef": [{"nProc": "string",
"indProc": 0,
"tpAto": "string"
}
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [{"dia": 1,
"qtde": 0
}
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [{"xDed": "string",
"vDed": 0
}
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [{"nReceituario": "string",
"CPFRespTec": "string"
}
],
"guiaTransito": {"tpGuia": 0,
"UFGuia": "string",
"serieGuia": "string",
"nGuia": "string"
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": "string",
"RSAKeyValue": {"Modulus": "string",
"Exponent": "string"
}
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}

Prévia do XML da NF-e

Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do XML, sem a assinatura digital.

Os dados de entrada são os mesmos do endpoint de emissão de NF-e (POST /nfe).

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

required	object (NfeSefazInfNFe) Informações da Nota Fiscal eletrônica.
	object (NfeSefazInfNFeSupl) Informações suplementares Nota Fiscal.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.

Responses

Response Schema: /

string <binary>

Request samples

Payload

Content type

application/json

{"infNFe": {"versao": "string",
"Id": "string",
"ide": {"cUF": 0,
"cNF": "string",
"natOp": "string",
"mod": 0,
"serie": 0,
"nNF": 1,
"dhEmi": "2019-08-24T14:15:22Z",
"dhSaiEnt": "2019-08-24T14:15:22Z",
"dPrevEntrega": "2019-08-24",
"tpNF": 0,
"idDest": 0,
"cMunFG": "string",
"cMunFGIBS": "string",
"tpImp": 0,
"tpEmis": 0,
"cDV": 0,
"tpAmb": 0,
"finNFe": 0,
"tpNFDebito": "string",
"tpNFCredito": "string",
"indFinal": 0,
"indPres": 0,
"indIntermed": 0,
"cIndOp": "string",
"procEmi": 0,
"verProc": "string",
"dhCont": "2019-08-24T14:15:22Z",
"xJust": "stringstringstr",
"NFref": [{"refNFe": "string",
"refNFeSig": "string",
"refNF": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"mod": null,
"serie": null,
"nNF": null
},
"refNFP": {"cUF": null,
"AAMM": null,
"CNPJ": null,
"CPF": null,
"IE": null,
"mod": null,
"serie": null,
"nNF": null
},
"refCTe": "string",
"refECF": {"mod": null,
"nECF": null,
"nCOO": null
}
}
],
"gCompraGov": {"tpEnteGov": 0,
"pRedutor": 0,
"tpOperGov": 0,
"refDFeAnt": ["string"
]
},
"gPagAntecipado": {"refNFe": ["string"
]
}
},
"emit": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xFant": "string",
"enderEmit": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"IE": "string",
"IEST": "string",
"IM": "string",
"CNAE": "string",
"CRT": 0,
"ISUFEmit": "string"
},
"avulsa": {"CNPJ": "string",
"xOrgao": "string",
"matr": "string",
"xAgente": "string",
"fone": "string",
"UF": "string",
"nDAR": "string",
"dEmi": "2019-08-24",
"vDAR": 0,
"repEmi": "string",
"dPag": "2019-08-24"
},
"dest": {"CNPJ": "string",
"CPF": "string",
"idEstrangeiro": "string",
"xNome": "string",
"enderDest": {"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string"
},
"indIEDest": 0,
"IE": "string",
"ISUF": "string",
"IM": "string",
"email": "string"
},
"retirada": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"entrega": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"xLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string",
"cMun": "string",
"xMun": "string",
"UF": "string",
"CEP": "string",
"cPais": "string",
"xPais": "string",
"fone": "string",
"email": "string",
"IE": "string"
},
"autXML": [{"CNPJ": "string",
"CPF": "string"
}
],
"det": [{"nItem": 1,
"prod": {"cProd": "string",
"cEAN": "string",
"cBarra": "string",
"xProd": "string",
"NCM": "string",
"NVE": [null
],
"CEST": "string",
"indEscala": "string",
"CNPJFab": "string",
"cBenef": "string",
"gCred": [null
],
"tpCredPresIBSZFM": 0,
"EXTIPI": "string",
"CFOP": "string",
"uCom": "string",
"qCom": 0,
"vUnCom": 0,
"vProd": 0,
"cEANTrib": "string",
"cBarraTrib": "string",
"uTrib": "string",
"qTrib": 0,
"vUnTrib": 0,
"vFrete": 1,
"vSeg": 1,
"vDesc": 1,
"vOutro": 1,
"indTot": 0,
"indBemMovelUsado": 0,
"DI": [null
],
"detExport": [null
],
"xPed": "string",
"nItemPed": 0,
"nFCI": "string",
"rastro": [null
],
"infProdNFF": {"cProdFisco": null,
"cOperNFF": null
},
"infProdEmb": {"xEmb": null,
"qVolEmb": null,
"uEmb": null
},
"veicProd": {"tpOp": null,
"chassi": null,
"cCor": null,
"xCor": null,
"pot": null,
"cilin": null,
"pesoL": null,
"pesoB": null,
"nSerie": null,
"tpComb": null,
"nMotor": null,
"CMT": null,
"dist": null,
"anoMod": null,
"anoFab": null,
"tpPint": null,
"tpVeic": null,
"espVeic": null,
"VIN": null,
"condVeic": null,
"cMod": null,
"cCorDENATRAN": null,
"lota": null,
"tpRest": null
},
"med": {"cProdANVISA": null,
"xMotivoIsencao": null,
"vPMC": null
},
"arma": [null
],
"comb": {"cProdANP": null,
"descANP": null,
"pGLP": null,
"pGNn": null,
"pGNi": null,
"vPart": null,
"CODIF": null,
"qTemp": null,
"UFCons": null,
"CIDE": null,
"encerrante": null,
"pBio": null,
"origComb": [ ]
},
"nRECOPI": "string"
},
"imposto": {"vTotTrib": 0,
"ICMS": {"ICMS00": null,
"ICMS02": null,
"ICMS10": null,
"ICMS15": null,
"ICMS20": null,
"ICMS30": null,
"ICMS40": null,
"ICMS51": null,
"ICMS53": null,
"ICMS60": null,
"ICMS61": null,
"ICMS70": null,
"ICMS90": null,
"ICMSPart": null,
"ICMSST": null,
"ICMSSN101": null,
"ICMSSN102": null,
"ICMSSN201": null,
"ICMSSN202": null,
"ICMSSN500": null,
"ICMSSN900": null
},
"IPI": {"CNPJProd": null,
"cSelo": null,
"qSelo": null,
"cEnq": null,
"IPITrib": null,
"IPINT": null
},
"II": {"vBC": null,
"vDespAdu": null,
"vII": null,
"vIOF": null
},
"ISSQN": {"vBC": null,
"vAliq": null,
"vISSQN": null,
"cMunFG": null,
"cListServ": null,
"vDeducao": null,
"vOutro": null,
"vDescIncond": null,
"vDescCond": null,
"vISSRet": null,
"indISS": null,
"cServico": null,
"cMun": null,
"cPais": null,
"nProcesso": null,
"indIncentivo": null
},
"PIS": {"PISAliq": null,
"PISQtde": null,
"PISNT": null,
"PISOutr": null
},
"PISST": {"vBC": null,
"pPIS": null,
"qBCProd": null,
"vAliqProd": null,
"vPIS": null,
"indSomaPISST": null
},
"COFINS": {"COFINSAliq": null,
"COFINSQtde": null,
"COFINSNT": null,
"COFINSOutr": null
},
"COFINSST": {"vBC": null,
"pCOFINS": null,
"qBCProd": null,
"vAliqProd": null,
"vCOFINS": null,
"indSomaCOFINSST": null
},
"ICMSUFDest": {"vBCUFDest": null,
"vBCFCPUFDest": null,
"pFCPUFDest": null,
"pICMSUFDest": null,
"pICMSInter": null,
"pICMSInterPart": null,
"vFCPUFDest": null,
"vICMSUFDest": null,
"vICMSUFRemet": null
},
"IS": {"CSTIS": null,
"cClassTribIS": null,
"vBCIS": null,
"pIS": null,
"adRemIS": null,
"uTrib": null,
"qTrib": null,
"vIS": null
},
"IBSCBS": {"CST": null,
"cClassTrib": null,
"indDoacao": null,
"gIBSCBS": null,
"gIBSCBSMono": null,
"gTransfCred": null,
"gAjusteCompet": null,
"gEstornoCred": null,
"gCredPresOper": null,
"gCredPresIBSZFM": null
}
},
"impostoDevol": {"pDevol": 0,
"IPI": {"vIPIDevol": null
}
},
"infAdProd": "string",
"obsItem": {"obsCont": {"xCampo": null,
"xTexto": null
},
"obsFisco": {"xCampo": null,
"xTexto": null
}
},
"vItem": 0,
"DFeReferenciado": {"chaveAcesso": "string",
"nItem": 1
}
}
],
"total": {"ICMSTot": {"vBC": 0,
"vICMS": 0,
"vICMSDeson": 0,
"vFCPUFDest": 0,
"vICMSUFDest": 0,
"vICMSUFRemet": 0,
"vFCP": 0,
"vBCST": 0,
"vST": 0,
"vFCPST": 0,
"vFCPSTRet": 0,
"qBCMono": 0,
"vICMSMono": 0,
"qBCMonoReten": 0,
"vICMSMonoReten": 0,
"qBCMonoRet": 0,
"vICMSMonoRet": 0,
"vProd": 0,
"vFrete": 0,
"vSeg": 0,
"vDesc": 0,
"vII": 0,
"vIPI": 0,
"vIPIDevol": 0,
"vPIS": 0,
"vCOFINS": 0,
"vOutro": 0,
"vNF": 0,
"vTotTrib": 0
},
"ISSQNtot": {"vServ": 1,
"vBC": 1,
"vISS": 1,
"vPIS": 1,
"vCOFINS": 1,
"dCompet": "2019-08-24",
"vDeducao": 1,
"vOutro": 1,
"vDescIncond": 1,
"vDescCond": 1,
"vISSRet": 1,
"cRegTrib": 0
},
"retTrib": {"vRetPIS": 1,
"vRetCOFINS": 1,
"vRetCSLL": 1,
"vBCIRRF": 1,
"vIRRF": 1,
"vBCRetPrev": 1,
"vRetPrev": 1
},
"ISTot": {"vIS": 0
},
"IBSCBSTot": {"vBCIBSCBS": 0,
"gIBS": {"gIBSUF": {"vDif": null,
"vDevTrib": null,
"vIBSUF": null
},
"gIBSMun": {"vDif": null,
"vDevTrib": null,
"vIBSMun": null
},
"vIBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gCBS": {"vDif": 0,
"vDevTrib": 0,
"vCBS": 0,
"vCredPres": 0,
"vCredPresCondSus": 0
},
"gMono": {"vIBSMono": 0,
"vCBSMono": 0,
"vIBSMonoReten": 0,
"vCBSMonoReten": 0,
"vIBSMonoRet": 0,
"vCBSMonoRet": 0
},
"gEstornoCred": {"vIBSEstCred": 0,
"vCBSEstCred": 0
}
},
"vNFTot": 0
},
"transp": {"modFrete": 0,
"transporta": {"CNPJ": "string",
"CPF": "string",
"xNome": "string",
"IE": "string",
"xEnder": "string",
"xMun": "string",
"UF": "string"
},
"retTransp": {"vServ": 0,
"vBCRet": 0,
"pICMSRet": 0,
"vICMSRet": 0,
"CFOP": "string",
"cMunFG": "string"
},
"veicTransp": {"placa": "string",
"UF": "string",
"RNTC": "string"
},
"reboque": [{"placa": "string",
"UF": "string",
"RNTC": "string"
}
],
"vagao": "string",
"balsa": "string",
"vol": [{"qVol": 0,
"esp": "string",
"marca": "string",
"nVol": "string",
"pesoL": 0,
"pesoB": 0,
"lacres": [null
]
}
]
},
"cobr": {"fat": {"nFat": "string",
"vOrig": 0,
"vDesc": 0,
"vLiq": 0
},
"dup": [{"nDup": "string",
"dVenc": "2019-08-24",
"vDup": 1
}
]
},
"pag": {"detPag": [{"indPag": 0,
"tPag": "string",
"xPag": "string",
"vPag": 0,
"dPag": "2019-08-24",
"CNPJPag": "string",
"UFPag": "string",
"card": {"tpIntegra": null,
"CNPJ": null,
"tBand": null,
"cAut": null,
"CNPJReceb": null,
"idTermPag": null
}
}
],
"vTroco": 0
},
"infIntermed": {"CNPJ": "string",
"idCadIntTran": "string"
},
"infAdic": {"infAdFisco": "string",
"infCpl": "string",
"obsCont": [{"xCampo": "string",
"xTexto": "string"
}
],
"obsFisco": [{"xCampo": "string",
"xTexto": "string"
}
],
"procRef": [{"nProc": "string",
"indProc": 0,
"tpAto": "string"
}
]
},
"exporta": {"UFSaidaPais": "string",
"xLocExporta": "string",
"xLocDespacho": "string"
},
"compra": {"xNEmp": "string",
"xPed": "string",
"xCont": "string"
},
"cana": {"safra": "string",
"ref": "string",
"forDia": [{"dia": 1,
"qtde": 0
}
],
"qTotMes": 0,
"qTotAnt": 0,
"qTotGer": 0,
"deduc": [{"xDed": "string",
"vDed": 0
}
],
"vFor": 0,
"vTotDed": 0,
"vLiqFor": 0
},
"infRespTec": {"CNPJ": "string",
"xContato": "string",
"email": "string",
"fone": "string",
"idCSRT": 0,
"CSRT": "string",
"hashCSRT": "string"
},
"infSolicNFF": {"xSolic": "string"
},
"agropecuario": {"defensivo": [{"nReceituario": "string",
"CPFRespTec": "string"
}
],
"guiaTransito": {"tpGuia": 0,
"UFGuia": "string",
"serieGuia": "string",
"nGuia": "string"
}
},
"infPAA": {"CNPJPAA": "string",
"PAASignature": {"SignatureValue": "string",
"RSAKeyValue": {"Modulus": "string",
"Exponent": "string"
}
}
}
},
"infNFeSupl": {"qrCode": "stringstringstringstringstringstringstringstringstringstring",
"urlChave": "stringstringstringstr"
},
"ambiente": "homologacao",
"referencia": "string"
}

Sincroniza dados na NF-e a partir da SEFAZ

Realiza a sincronização dos dados a partir da consulta da situação atual da NF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.

Cenários de uso:

Sincronizar uma nota que se encontra com o status erro na API, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).
Sincronizar uma nota que se encontra com o status autorizadona API, mas está cancelada na SEFAZ.
Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota que porventura não tenham sido feitos a partir da API.

Informações adicionais:

Consumo: 1 unidade por evento sincronizado ou requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Responses

Response Schema: application/json

status	string Enum: "pendente" "sincronizado" "erro" Situação atual da sincronização.
codigo_status	integer Código da situação atual do DF-e.
motivo_status	string Descrição literal da situação atual do DF-e.
data_recebimento	string <date-time> Data e hora de processamento.
chave	string Chave de Acesso do DF-e consultado.

Response samples

Content type

application/json

{"status": "pendente",
"codigo_status": 0,
"motivo_status": "string",
"data_recebimento": "2019-08-24T14:15:22Z",
"chave": "string"
}

Solicitar correção da NF-e

é possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NF-e gerado pela API.

Request Body schema: application/json
required

Contém os dados do pedido para carta de correção.

correcao

string <= 1000 characters

Correção a ser considerada.

Responses

Response Schema: application/json

correcao	string Correção a ser considerada.
id	string ID único gerado pela API para este evento.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
	object (DfeAutorEvento)
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer Sequencial do evento para o mesmo tipo de evento.
data_recebimento	string or null <date-time> Data e hora do recebimento do Evento pela SEFAZ.
codigo_status	integer Código do status de registro do Evento.
motivo_status	string Descrição literal do status do registro do Evento.
numero_protocolo	string Número do Protocolo de registro do Evento.
codigo_mensagem	integer Código da Mensagem.
mensagem	string Mensagem da SEFAZ para o emissor.
tipo_evento	string

Request samples

Payload

Content type

application/json

{"correcao": "string"
}

Response samples

Content type

application/json

{"correcao": "string",
"id": "string",
"ambiente": "homologacao",
"status": "pendente",
"autor": {"cpf_cnpj": "string"
},
"chave_acesso": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"data_recebimento": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string",
"codigo_mensagem": 0,
"mensagem": "string",
"tipo_evento": "string"
}

NFS-e

Nota Fiscal de Serviço Eletrônica.

Baixar PDF do DANFSE

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
mensagem_rodape	string <= 120 characters Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"` Default: `""`

Responses

Response Schema: /

string <binary>

Baixar XML da DPS

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML da NFS-e processada

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do evento de cancelamento

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

Responses

Response Schema: /

string <binary>

Cancelar uma NFS-e autorizada

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

Request Body schema: application/json

codigo	string Código de cancelamento, exigido por algumas prefeituras. Para saber quais valores são aceitos, consulte o manual da prefeitura.
motivo	string Motivo de cancelamento, exigido por algumas prefeituras.

Responses

Response Schema: application/json

id	string ID único do cancelamento gerado automaticamente pela API.
status	string Enum: "pendente" "concluido" "rejeitado" "erro"
codigo	string
motivo	string
data_hora	string or null <date-time>
	Array of objects (NfseMensagemRetorno)

Request samples

Payload

Content type

application/json

{"codigo": "string",
"motivo": "string"
}

Response samples

Content type

application/json

{"id": "string",
"status": "pendente",
"codigo": "string",
"motivo": "string",
"data_hora": "2019-08-24T14:15:22Z",
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
]
}

Cidades atendidas

Fornece uma relação completa de todos os municípios atendidos pela API.

Authorizations:

oauth2

Responses

Response Schema: application/json

@count	integer Quantidade de cidades atendidas pela API.
data	Array of strings Lista com os códigos IBGE das cidades atendidas pela API.

Response samples

Content type

application/json

{"@count": 0,
"data": ["string"
]
}

Consultar lote de NFS-e

Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único do lote gerado pela API.

Responses

Response Schema: application/json

id	string ID único do lote gerado automaticamente pela API.
created_at	string <date-time>
status	string Enum: "novo" "fila_envio" "fila_consulta" "processado" "erro"
numero	string
ambiente	string Enum: "homologacao" "producao"
referencia	string
	Array of objects (Nfse)

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "novo",
"numero": "string",
"ambiente": "homologacao",
"referencia": "string",
"notas": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"numero": "string",
"codigo_verificacao": "string",
"link_url": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"referencia": "string",
"DPS": {"serie": "string",
"nDPS": "string"
},
"cancelamento": {"id": "string",
"status": "pendente",
"codigo": "string",
"motivo": "string",
"data_hora": "2019-08-24T14:15:22Z",
"mensagens": [{"codigo": null,
"descricao": null,
"correcao": null
}
]
},
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
],
"declaracao_prestacao_servico": {"rps": {"identificacao_rps": {"numero": null,
"serie": null,
"tipo": null
},
"data_emissao": "2019-08-24T14:15:22Z"
},
"competencia": "2019-08-24T14:15:22Z",
"natureza_tributacao": 0,
"prestador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": null,
"numero": null,
"complemento": null,
"bairro": null,
"codigo_municipio": null,
"cidade": null,
"uf": null,
"codigo_pais": null,
"pais": null,
"cep": null
},
"optante_simples_nacional": true,
"regime_tributacao": 0,
"regime_especial_tributacao": 0,
"incentivo_fiscal": true,
"incentivador_cultural": true
},
"tomador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": null,
"numero": null,
"complemento": null,
"bairro": null,
"codigo_municipio": null,
"cidade": null,
"uf": null,
"codigo_pais": null,
"pais": null,
"cep": null
}
},
"intermediario": {"cpf_cnpj": "string",
"nome_razao_social": "string",
"inscricao_municipal": "string"
},
"construcao_civil": {"codigo_obra": "string",
"art": "string"
},
"servicos": [{"iss_retido": null,
"responsavel_retencao": null,
"item_lista_servico": null,
"codigo_cnae": null,
"codigo_tributacao_municipio": null,
"discriminacao": null,
"codigo_municipio": null,
"codigo_pais": null,
"tipo_tributacao": null,
"exigibilidade_iss": null,
"codigo_municipio_incidencia": null,
"numero_processo": null,
"unidade": null,
"quantidade": null,
"valores": null
}
],
"outras_informacoes": "string"
}
}
]
}

Consultar metadados

Consulta a disponibilidade de emissão e alguns metadados de um município.

Authorizations:

oauth2

path Parameters

codigo_ibge

required

string

Código IBGE do município.

Responses

Response Schema: application/json

codigo_ibge	string Código IBGE do município.
uf	string UF do município.
municipio	string Nome do município.
provedor	string Provedor do município.
ambientes	Array of strings Items Enum: "homologacao" "producao" Ambientes disponíveis no provedor.
credenciais	Array of strings Items Enum: "certificado" "login_senha" "token" Credenciais requeridas para autenticação no provedor.

Response samples

Content type

application/json

{"codigo_ibge": "string",
"uf": "string",
"municipio": "string",
"provedor": "string",
"ambientes": ["homologacao"
],
"credenciais": ["certificado"
]
}

Consultar NFS-e

Consulta os detalhes de uma NFS-e já existente. Forneça o ID único obtido de uma requisição de criação ou de listagem de notas e a API irá retornar as informações da nota correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

Responses

Response Schema: application/json

id	string ID único da nota gerado automaticamente pela API.
created_at	string <date-time>
status	string Enum: "processando" "autorizada" "negada" "cancelada" "substituida" "erro"
numero	string
codigo_verificacao	string
link_url	string
data_emissao	string or null <date-time>
ambiente	string Enum: "homologacao" "producao"
referencia	string
	object (DPS) Grupo de informações da DPS relativas ao serviço prestado.
	object (NfseCancelamento)
	Array of objects (NfseMensagemRetorno)
	object (Rps) Propriedade obsoleta. Não é mais retornada pela API.

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"numero": "string",
"codigo_verificacao": "string",
"link_url": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"referencia": "string",
"DPS": {"serie": "string",
"nDPS": "string"
},
"cancelamento": {"id": "string",
"status": "pendente",
"codigo": "string",
"motivo": "string",
"data_hora": "2019-08-24T14:15:22Z",
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
]
},
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
],
"declaracao_prestacao_servico": {"rps": {"identificacao_rps": {"numero": "string",
"serie": "string",
"tipo": "string"
},
"data_emissao": "2019-08-24T14:15:22Z"
},
"competencia": "2019-08-24T14:15:22Z",
"natureza_tributacao": 0,
"prestador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
},
"optante_simples_nacional": true,
"regime_tributacao": 0,
"regime_especial_tributacao": 0,
"incentivo_fiscal": true,
"incentivador_cultural": true
},
"tomador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "string",
"cep": "string"
}
},
"intermediario": {"cpf_cnpj": "string",
"nome_razao_social": "string",
"inscricao_municipal": "string"
},
"construcao_civil": {"codigo_obra": "string",
"art": "string"
},
"servicos": [{"iss_retido": false,
"responsavel_retencao": 0,
"item_lista_servico": "string",
"codigo_cnae": "string",
"codigo_tributacao_municipio": "string",
"discriminacao": "string",
"codigo_municipio": "string",
"codigo_pais": "string",
"tipo_tributacao": 6,
"exigibilidade_iss": 1,
"codigo_municipio_incidencia": "string",
"numero_processo": "string",
"unidade": "string",
"quantidade": 1,
"valores": {"valor_unitario": 0,
"valor_servicos": 0,
"valor_deducoes": 0,
"valor_pis": 0,
"valor_cofins": 0,
"valor_inss": 0,
"valor_ir": 0,
"valor_csll": 0,
"valor_outras_retencoes": 0,
"valor_iss": 0,
"valor_iss_retido": 0,
"valor_liquido": 0,
"aliquota_iss": 0,
"aliquota_pis": 0,
"aliquota_cofins": 0,
"aliquota_inss": 0,
"aliquota_ir": 0,
"aliquota_csll": 0,
"desconto_incondicionado": 0,
"desconto_condicionado": 0
}
}
],
"outras_informacoes": "string"
}
}

Consultar o cancelamento da NFS-e

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

Responses

Response Schema: application/json

id	string ID único do cancelamento gerado automaticamente pela API.
status	string Enum: "pendente" "concluido" "rejeitado" "erro"
codigo	string
motivo	string
data_hora	string or null <date-time>
	Array of objects (NfseMensagemRetorno)

Response samples

Content type

application/json

{"id": "string",
"status": "pendente",
"codigo": "string",
"motivo": "string",
"data_hora": "2019-08-24T14:15:22Z",
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
]
}

Emitir lote de NFS-e

Informações adicionais:

Consumo: 1 unidade por NFS-e.

Authorizations:

oauth2

Request Body schema: application/json
required

provedor	string Enum: "padrao" "nacional" Default: `"padrao"` Identificação do provedor para transmissão da DPS: `"padrao"`: Provedor padrão da prefeitura. `"nacional"`: Ambiente de Dados Nacional (ADN) do Sistema Nacional NFS-e.
ambiente required	string or null Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
numeroLote	integer or null <int64> Número do lote. Use apenas quando a numeração automática estiver desativada na configuração da empresa.
	Array of objects (NfseDpsPedidoEmissao) <= 50 items Lista com as informações das DPS relativas aos serviços prestados.

Responses

Response Schema: application/json

id	string ID único do lote gerado automaticamente pela API.
created_at	string <date-time>
status	string Enum: "novo" "fila_envio" "fila_consulta" "processado" "erro"
numero	string
ambiente	string Enum: "homologacao" "producao"
referencia	string
	Array of objects (Nfse)

Request samples

Payload

Content type

application/json

{"provedor": "padrao",
"ambiente": "homologacao",
"referencia": "string",
"numeroLote": 0,
"documentos": [{"provedor": "padrao",
"ambiente": "homologacao",
"referencia": "string",
"numeroLote": 0,
"infDPS": {"tpAmb": 0,
"dhEmi": "2019-08-24T14:15:22Z",
"verAplic": "string",
"serie": "strin",
"nDPS": "string",
"dCompet": "2019-08-24",
"cMotivoEmisTI": 0,
"finNFSe": 0,
"chNFSeRej": "string",
"subst": {"chSubstda": "string",
"cMotivo": "string",
"xMotivo": "stringstringstr"
},
"prest": {"CNPJ": "string",
"CPF": "string",
"regTrib": {"regEspTrib": null
}
},
"toma": {"orgaoPublico": false,
"CNPJ": "string",
"CPF": "string",
"NIF": "string",
"cNaoNIF": 0,
"CAEPF": "string",
"IM": "string",
"IE": "string",
"xNome": "string",
"end": {"endNac": null,
"endExt": null,
"xLgr": null,
"tpLgr": null,
"nro": null,
"xCpl": null,
"xBairro": null
},
"fone": "string",
"email": "string"
},
"interm": {"CNPJ": "string",
"CPF": "string",
"NIF": "string",
"cNaoNIF": 0,
"CAEPF": "string",
"IM": "string",
"IE": "string",
"xNome": "string",
"end": {"endNac": null,
"endExt": null,
"xLgr": null,
"tpLgr": null,
"nro": null,
"xCpl": null,
"xBairro": null
},
"fone": "string",
"email": "string"
},
"serv": {"locPrest": {"cLocPrestacao": null,
"cPaisPrestacao": null
},
"cServ": {"cTribNac": null,
"cTribMun": null,
"CNAE": null,
"xDescServ": null,
"cNBS": null,
"cNatOp": null,
"cSitTrib": null,
"cIntContrib": null
},
"comExt": {"mdPrestacao": null,
"vincPrest": null,
"tpMoeda": null,
"vServMoeda": null,
"mecAFComexP": null,
"mecAFComexT": null,
"movTempBens": null,
"nDI": null,
"nRE": null,
"mdic": null
},
"obra": {"inscImobFisc": null,
"cObra": null,
"cCIB": null,
"end": null
},
"atvEvento": {"xNome": null,
"desc": null,
"dtIni": null,
"dtFim": null,
"idAtvEvt": null,
"id": null,
"end": null
},
"infoCompl": {"idDocTec": null,
"docRef": null,
"xPed": null,
"gItemPed": null,
"xInfComp": null
}
},
"valores": {"vServPrest": {"vReceb": null,
"vServ": null
},
"vDescCondIncond": {"vDescIncond": null,
"vDescCond": null
},
"vAjusteBC": {"pAjusteBCISSQN": null,
"vAjusteBCISSQN": null,
"documentos": null
},
"vDedRed": {"pDR": null,
"vDR": null,
"documentos": null
},
"trib": {"tribMun": null,
"tribFed": null,
"totTrib": null
}
},
"IBSCBS": {"finNFSe": 0,
"indFinal": 0,
"cIndOp": "string",
"tpOper": 0,
"gRefNFSe": {"refNFSe": [ ]
},
"tpEnteGov": 0,
"indDest": 0,
"dest": {"CNPJ": null,
"CPF": null,
"NIF": null,
"cNaoNIF": null,
"xNome": null,
"end": null,
"fone": null,
"email": null
},
"imovel": {"cMun": null,
"gLocacao": null,
"gUnidImob": [ ],
"inscImobFisc": null,
"cCIB": null,
"end": null
},
"bensMoveis": [null
],
"valores": {"gReeRepRes": null,
"trib": null,
"tribAbrasf": null
}
}
}
}
]
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "novo",
"numero": "string",
"ambiente": "homologacao",
"referencia": "string",
"notas": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"numero": "string",
"codigo_verificacao": "string",
"link_url": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"referencia": "string",
"DPS": {"serie": "string",
"nDPS": "string"
},
"cancelamento": {"id": "string",
"status": "pendente",
"codigo": "string",
"motivo": "string",
"data_hora": "2019-08-24T14:15:22Z",
"mensagens": [{"codigo": null,
"descricao": null,
"correcao": null
}
]
},
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
],
"declaracao_prestacao_servico": {"rps": {"identificacao_rps": {"numero": null,
"serie": null,
"tipo": null
},
"data_emissao": "2019-08-24T14:15:22Z"
},
"competencia": "2019-08-24T14:15:22Z",
"natureza_tributacao": 0,
"prestador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": null,
"numero": null,
"complemento": null,
"bairro": null,
"codigo_municipio": null,
"cidade": null,
"uf": null,
"codigo_pais": null,
"pais": null,
"cep": null
},
"optante_simples_nacional": true,
"regime_tributacao": 0,
"regime_especial_tributacao": 0,
"incentivo_fiscal": true,
"incentivador_cultural": true
},
"tomador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": null,
"numero": null,
"complemento": null,
"bairro": null,
"codigo_municipio": null,
"cidade": null,
"uf": null,
"codigo_pais": null,
"pais": null,
"cep": null
}
},
"intermediario": {"cpf_cnpj": "string",
"nome_razao_social": "string",
"inscricao_municipal": "string"
},
"construcao_civil": {"codigo_obra": "string",
"art": "string"
},
"servicos": [{"iss_retido": null,
"responsavel_retencao": null,
"item_lista_servico": null,
"codigo_cnae": null,
"codigo_tributacao_municipio": null,
"discriminacao": null,
"codigo_municipio": null,
"codigo_pais": null,
"tipo_tributacao": null,
"exigibilidade_iss": null,
"codigo_municipio_incidencia": null,
"numero_processo": null,
"unidade": null,
"quantidade": null,
"valores": null
}
],
"outras_informacoes": "string"
}
}
]
}

Emitir NFS-e

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

provedor	string Enum: "padrao" "nacional" Default: `"padrao"` Identificação do provedor para transmissão da DPS: `"padrao"`: Provedor padrão da prefeitura. `"nacional"`: Ambiente de Dados Nacional (ADN) do Sistema Nacional NFS-e.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
referencia	string or null <= 50 characters Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.
numeroLote	integer or null <int64> Numero do lote. Use apenas quando a numeracao automatica estiver desativada na configuracao da empresa.
required	object (InfDPS) Grupo de informações da DPS relativas ao serviço prestado.

Responses

Response Schema: application/json

id	string ID único da nota gerado automaticamente pela API.
created_at	string <date-time>
status	string Enum: "processando" "autorizada" "negada" "cancelada" "substituida" "erro"
numero	string
codigo_verificacao	string
link_url	string
data_emissao	string or null <date-time>
ambiente	string Enum: "homologacao" "producao"
referencia	string
	object (DPS) Grupo de informações da DPS relativas ao serviço prestado.
	object (NfseCancelamento)
	Array of objects (NfseMensagemRetorno)
	object (Rps) Propriedade obsoleta. Não é mais retornada pela API.

Request samples

Payload

Content type

application/json

{"provedor": "padrao",
"ambiente": "homologacao",
"referencia": "string",
"numeroLote": 0,
"infDPS": {"tpAmb": 0,
"dhEmi": "2019-08-24T14:15:22Z",
"verAplic": "string",
"serie": "strin",
"nDPS": "string",
"dCompet": "2019-08-24",
"cMotivoEmisTI": 0,
"finNFSe": 0,
"chNFSeRej": "string",
"subst": {"chSubstda": "string",
"cMotivo": "string",
"xMotivo": "stringstringstr"
},
"prest": {"CNPJ": "string",
"CPF": "string",
"regTrib": {"regEspTrib": 0
}
},
"toma": {"orgaoPublico": false,
"CNPJ": "string",
"CPF": "string",
"NIF": "string",
"cNaoNIF": 0,
"CAEPF": "string",
"IM": "string",
"IE": "string",
"xNome": "string",
"end": {"endNac": {"cMun": "string",
"CEP": "string"
},
"endExt": {"cPais": "string",
"cEndPost": "string",
"xCidade": "string",
"xEstProvReg": "string"
},
"xLgr": "string",
"tpLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string"
},
"fone": "string",
"email": "string"
},
"interm": {"CNPJ": "string",
"CPF": "string",
"NIF": "string",
"cNaoNIF": 0,
"CAEPF": "string",
"IM": "string",
"IE": "string",
"xNome": "string",
"end": {"endNac": {"cMun": "string",
"CEP": "string"
},
"endExt": {"cPais": "string",
"cEndPost": "string",
"xCidade": "string",
"xEstProvReg": "string"
},
"xLgr": "string",
"tpLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string"
},
"fone": "string",
"email": "string"
},
"serv": {"locPrest": {"cLocPrestacao": "string",
"cPaisPrestacao": "string"
},
"cServ": {"cTribNac": "string",
"cTribMun": "string",
"CNAE": "string",
"xDescServ": "string",
"cNBS": "string",
"cNatOp": "string",
"cSitTrib": "string",
"cIntContrib": "string"
},
"comExt": {"mdPrestacao": 0,
"vincPrest": 0,
"tpMoeda": "str",
"vServMoeda": 0,
"mecAFComexP": "string",
"mecAFComexT": "string",
"movTempBens": 0,
"nDI": "string",
"nRE": "string",
"mdic": 0
},
"obra": {"inscImobFisc": "string",
"cObra": "string",
"cCIB": "string",
"end": {"CEP": "string",
"endExt": {"cEndPost": null,
"xCidade": null,
"xEstProvReg": null
},
"xLgr": "string",
"tpLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string"
}
},
"atvEvento": {"xNome": "string",
"desc": "string",
"dtIni": "2019-08-24",
"dtFim": "2019-08-24",
"idAtvEvt": "string",
"id": "string",
"end": {"CEP": "string",
"endExt": {"cEndPost": null,
"xCidade": null,
"xEstProvReg": null
},
"xLgr": "string",
"tpLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string"
}
},
"infoCompl": {"idDocTec": "string",
"docRef": "string",
"xPed": "string",
"gItemPed": {"xItemPed": [null
]
},
"xInfComp": "string"
}
},
"valores": {"vServPrest": {"vReceb": 0,
"vServ": 0
},
"vDescCondIncond": {"vDescIncond": 0,
"vDescCond": 0
},
"vAjusteBC": {"pAjusteBCISSQN": 0,
"vAjusteBCISSQN": 0,
"documentos": {"docAjusteBC": [null
]
}
},
"vDedRed": {"pDR": 0,
"vDR": 0,
"documentos": {"docDedRed": [null
]
}
},
"trib": {"tribMun": {"tribISSQN": 0,
"cPaisResult": "string",
"tpImunidade": 0,
"exigSusp": {"tpSusp": null,
"nProcesso": null
},
"BM": {"tpBM": null,
"nBM": null,
"vRedBCBM": null,
"pRedBCBM": null
},
"tpRetISSQN": 1,
"pAliq": 0,
"cLocIncid": "string",
"vBC": 0,
"vISSQN": 0,
"vLiq": 0
},
"tribFed": {"piscofins": {"CST": null,
"vBCPisCofins": null,
"pAliqPis": null,
"pAliqCofins": null,
"vPis": null,
"vCofins": null,
"tpRetPisCofins": null
},
"vRetCP": 0,
"vRetIRRF": 0,
"vRetCSLL": 0
},
"totTrib": {"vTotTrib": {"vTotTribFed": null,
"vTotTribEst": null,
"vTotTribMun": null
},
"pTotTrib": {"pTotTribFed": null,
"pTotTribEst": null,
"pTotTribMun": null
},
"indTotTrib": 0,
"pTotTribSN": 0
}
}
},
"IBSCBS": {"finNFSe": 0,
"indFinal": 0,
"cIndOp": "string",
"tpOper": 0,
"gRefNFSe": {"refNFSe": ["string"
]
},
"tpEnteGov": 0,
"indDest": 0,
"dest": {"CNPJ": "string",
"CPF": "string",
"NIF": "string",
"cNaoNIF": 0,
"xNome": "string",
"end": {"endNac": {"cMun": null,
"CEP": null
},
"endExt": {"cPais": null,
"cEndPost": null,
"xCidade": null,
"xEstProvReg": null
},
"xLgr": "string",
"tpLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string"
},
"fone": "string",
"email": "string"
},
"imovel": {"cMun": "string",
"gLocacao": {"pCopropriedade": 0,
"vTotOper": 0,
"vDescIncondTot": 0,
"vDescCondTot": 0,
"dVencOrig": "2019-08-24"
},
"gUnidImob": [{"inscImobFisc": null,
"cCIB": null,
"end": null,
"gAjusteBCLocImoveis": [ ]
}
],
"inscImobFisc": "string",
"cCIB": "string",
"end": {"CEP": "string",
"endExt": {"cEndPost": null,
"xCidade": null,
"xEstProvReg": null
},
"xLgr": "string",
"tpLgr": "string",
"nro": "string",
"xCpl": "string",
"xBairro": "string"
}
},
"bensMoveis": [{"cNCMBemMovel": "string",
"xNCMBemMovel": "string",
"qtdNCMBemMovel": 0
}
],
"valores": {"gReeRepRes": {"documentos": [null
]
},
"trib": {"CST": "string",
"cClassTrib": "string",
"gIBSCBS": {"CST": null,
"cClassTrib": null,
"cCredPres": null,
"gTribRegular": null,
"gDif": null
}
},
"tribAbrasf": {"cLocIncidIBSCBS": "string",
"vBC": 0,
"fed": {"pCBS": null,
"pRedAliqCBS": null,
"pAliqEfetCBS": null,
"vCBS": null
},
"uf": {"pIBSUF": null,
"pRedAliqUF": null,
"pAliqEfetUF": null,
"vIBSUF": null
},
"mun": {"pIBSMun": null,
"pRedAliqMun": null,
"pAliqEfetMun": null,
"vIBSMun": null
}
}
}
}
}
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"numero": "string",
"codigo_verificacao": "string",
"link_url": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"referencia": "string",
"DPS": {"serie": "string",
"nDPS": "string"
},
"cancelamento": {"id": "string",
"status": "pendente",
"codigo": "string",
"motivo": "string",
"data_hora": "2019-08-24T14:15:22Z",
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
]
},
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
],
"declaracao_prestacao_servico": {"rps": {"identificacao_rps": {"numero": "string",
"serie": "string",
"tipo": "string"
},
"data_emissao": "2019-08-24T14:15:22Z"
},
"competencia": "2019-08-24T14:15:22Z",
"natureza_tributacao": 0,
"prestador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "Brasil",
"cep": "string"
},
"optante_simples_nacional": true,
"regime_tributacao": 0,
"regime_especial_tributacao": 0,
"incentivo_fiscal": true,
"incentivador_cultural": true
},
"tomador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"codigo_municipio": "string",
"cidade": "string",
"uf": "string",
"codigo_pais": "1058",
"pais": "string",
"cep": "string"
}
},
"intermediario": {"cpf_cnpj": "string",
"nome_razao_social": "string",
"inscricao_municipal": "string"
},
"construcao_civil": {"codigo_obra": "string",
"art": "string"
},
"servicos": [{"iss_retido": false,
"responsavel_retencao": 0,
"item_lista_servico": "string",
"codigo_cnae": "string",
"codigo_tributacao_municipio": "string",
"discriminacao": "string",
"codigo_municipio": "string",
"codigo_pais": "string",
"tipo_tributacao": 6,
"exigibilidade_iss": 1,
"codigo_municipio_incidencia": "string",
"numero_processo": "string",
"unidade": "string",
"quantidade": 1,
"valores": {"valor_unitario": 0,
"valor_servicos": 0,
"valor_deducoes": 0,
"valor_pis": 0,
"valor_cofins": 0,
"valor_inss": 0,
"valor_ir": 0,
"valor_csll": 0,
"valor_outras_retencoes": 0,
"valor_iss": 0,
"valor_iss_retido": 0,
"valor_liquido": 0,
"aliquota_iss": 0,
"aliquota_pis": 0,
"aliquota_cofins": 0,
"aliquota_inss": 0,
"aliquota_ir": 0,
"aliquota_csll": 0,
"desconto_incondicionado": 0,
"desconto_condicionado": 0
}
}
],
"outras_informacoes": "string"
}
}

Enviar e-mail

Envia o XML e PDF da nota via email.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

query Parameters

logotipo	boolean Default: false Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
mensagem_rodape	string <= 120 characters Imprime mensagem no rodapé do documento. O caractere `\|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens. Exemplos de Uso: `"esquerda"` `"esquerda\|centro"` `"esquerda\|centro\|direita"` `"\|centro"`, `"\|centro\|"` `"\|centro\|direita"` `"\|\|direita"` `"esquerda\|\|direita"` Default: `""`

Request Body schema: application/json

Array of objects (EnderecoEmail) <= 10 items

Lista de endereços de email para envio dos arquivos.

Caso nenhum email seja informado, será utilizado o email do destinatário do documento fiscal.

Array (<= 10 items)

required

string

Email do destinatário.

Responses

Response Schema: application/json

id required	string ID único gerado pela API para este email. Utilize-o no endpoint de consulta de email para obter informações detalhadas sobre o envio do email e rastrear todos os eventos relacionados, como envio, entrega, falhas e outros eventos relevantes.
status	string Enum: "pending" "sending" "sent" "delivered" "delivery_delayed" "bounced" "complained" "rejected" "cancelled" "failed"
status_message	string or null

Request samples

Payload

Content type

application/json

{"destinatarios": [{"email": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"status": "pending",
"status_message": "string"
}

Listar lotes de NFS-e

Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao

Responses

Response Schema: application/json

@count	integer
	Array of objects (RpsLote)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "novo",
"numero": "string",
"ambiente": "homologacao",
"referencia": "string",
"notas": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"numero": "string",
"codigo_verificacao": "string",
"link_url": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"referencia": "string",
"DPS": {"serie": null,
"nDPS": null
},
"cancelamento": {"id": null,
"status": null,
"codigo": null,
"motivo": null,
"data_hora": null,
"mensagens": [ ]
},
"mensagens": [null
],
"declaracao_prestacao_servico": {"rps": null,
"competencia": null,
"natureza_tributacao": null,
"prestador": null,
"tomador": null,
"intermediario": null,
"construcao_civil": null,
"servicos": [ ],
"outras_informacoes": null
}
}
]
}
]
}

Listar NFS-e

Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do emitente. Utilize o valor sem máscara.
referencia	string Seu identificador único para o documento.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
chave	string Chave de acesso do DF-e.
serie	string Série do DF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (Nfse)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"numero": "string",
"codigo_verificacao": "string",
"link_url": "string",
"data_emissao": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"referencia": "string",
"DPS": {"serie": "string",
"nDPS": "string"
},
"cancelamento": {"id": "string",
"status": "pendente",
"codigo": "string",
"motivo": "string",
"data_hora": "2019-08-24T14:15:22Z",
"mensagens": [{"codigo": null,
"descricao": null,
"correcao": null
}
]
},
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
],
"declaracao_prestacao_servico": {"rps": {"identificacao_rps": {"numero": null,
"serie": null,
"tipo": null
},
"data_emissao": "2019-08-24T14:15:22Z"
},
"competencia": "2019-08-24T14:15:22Z",
"natureza_tributacao": 0,
"prestador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"nome_fantasia": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": null,
"numero": null,
"complemento": null,
"bairro": null,
"codigo_municipio": null,
"cidade": null,
"uf": null,
"codigo_pais": null,
"pais": null,
"cep": null
},
"optante_simples_nacional": true,
"regime_tributacao": 0,
"regime_especial_tributacao": 0,
"incentivo_fiscal": true,
"incentivador_cultural": true
},
"tomador": {"cpf_cnpj": "string",
"inscricao_municipal": "string",
"nome_razao_social": "string",
"fone": "string",
"email": "string",
"endereco": {"logradouro": null,
"numero": null,
"complemento": null,
"bairro": null,
"codigo_municipio": null,
"cidade": null,
"uf": null,
"codigo_pais": null,
"pais": null,
"cep": null
}
},
"intermediario": {"cpf_cnpj": "string",
"nome_razao_social": "string",
"inscricao_municipal": "string"
},
"construcao_civil": {"codigo_obra": "string",
"art": "string"
},
"servicos": [{"iss_retido": null,
"responsavel_retencao": null,
"item_lista_servico": null,
"codigo_cnae": null,
"codigo_tributacao_municipio": null,
"discriminacao": null,
"codigo_municipio": null,
"codigo_pais": null,
"tipo_tributacao": null,
"exigibilidade_iss": null,
"codigo_municipio_incidencia": null,
"numero_processo": null,
"unidade": null,
"quantidade": null,
"valores": null
}
],
"outras_informacoes": "string"
}
}
]
}

Sincroniza dados na NFS-e a partir da Prefeitura

Realiza a sincronização dos dados a partir da consulta da situação atual da NFS-e na prefeitura.

Cenários de uso:

Sincronizar uma nota que se encontra com o status processando na API, mas está autorizada na prefeitura;
Sincronizar uma nota que se encontra com o status erro na API, mas está autorizada na prefeitura (útil em casos de erros de transmissão, como instabilidades e timeouts);
Sincronizar uma nota que se encontra com o status autorizadana API, mas está cancelada na prefeitura.

Informações adicionais:

Consumo: 1 unidade por evento sincronizado ou requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único da NFS-e gerado pela API.

Request Body schema: application/json

identificador

string

Identificador utilizado na consulta da situação atual da NFS-e.

O valor desse campo é opcional para as prefeituras que suportem consultas por número e série do RPS. Para as demais, esse campo torna-se obrigatório e o seu valor pode ser a chave de acesso, número da NFS-e, chave de verificação, protocolo ou outro identificador da nota a depender da prefeitura.

Responses

Response Schema: application/json

status	string Enum: "pendente" "sincronizado" "erro" Situação atual da sincronização.
	Array of objects (NfseMensagemRetorno)

Request samples

Payload

Content type

application/json

{"identificador": "string"
}

Response samples

Content type

application/json

{"status": "pendente",
"mensagens": [{"codigo": "string",
"descricao": "string",
"correcao": "string"
}
]
}

Distribuição NF-e

O processo de distribuição de DFe envolve a disponibilização dos documentos fiscais eletrônicos para os envolvidos na transação (emitentes, destinatários e terceiros autorizados). Ele permite que os destinatários recebam as NF-e emitidas contra o seu CNPJ diretamente do Ambiente Nacional, facilitando o controle e a gestão dos documentos recebidos.

Baixar PDF do documento

Utilize esse endpoint para obter o PDF do documento.

Schemas suportados:

procNFe_v4.00.xsd

Authorizations:

oauth2

path Parameters

required

string

ID único do documento gerado pela API.

Responses

Response Schema: /

string <binary>

Baixar XML do documento

Utilize esse endpoint para obter o XML das informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.

Informações adicionais:

Consumo: Primeira requisição isenta, posteriores 1 unidade por requisição.

Authorizations:

oauth2

path Parameters

required

string

ID único do documento gerado pela API.

Responses

Response Schema: /

string <binary>

Consultar distribuição

Authorizations:

oauth2

path Parameters

required

string

ID único da distribuição de NF-e gerada pela API.

Responses

Response Schema: application/json

id required	string ID único gerado pela API para o pedido de distribuição.
created_at	string <date-time> Data/hora em que o pedido foi criado na API. Representado no formato `ISO 8601`.
status required	string Enum: "processando" "concluido" "erro" Indica o status da distribuição.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
uf_autor	string or null Sigla da UF do autor.
tipo_consulta required	string Enum: "dist-nsu" "cons-nsu" "cons-chave"
dist_nsu	integer or null <int64> Distribuição de conjunto de DF-e a partir do NSU informado. Obrigatório quando `tipo_consulta` for `distNSU`.
cons_nsu	integer or null <int64> Consulta DF-e vinculado ao NSU informado. Obrigatório quando `tipo_consulta` for `consNSU`.
cons_chave	string or null Consulta de NF-e por chave de acesso informada. Obrigatório quando `tipo_consulta` for `consChNFe`.
codigo_status required	integer or null Código do status de processamento da requisição.
motivo_status	string or null Descrição do status de processamento da requisição.
data_hora_resposta required	string or null <date-time> Data e Hora de processamento da requisição.
ultimo_nsu required	integer or null <int64> Último NSU pesquisado no Ambiente Nacional. Se for o caso, o solicitante pode continuar a consulta a partir deste NSU para obter novos resultados.
max_nsu required	integer or null <int64> Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.
	Array of objects (DistribuicaoNfeDocumento) <= 50 items Conjunto de informações resumidas e documentos fiscais eletrônicos de interesse da pessoa ou empresa.

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"ambiente": "homologacao",
"uf_autor": "string",
"tipo_consulta": "dist-nsu",
"dist_nsu": 0,
"cons_nsu": 0,
"cons_chave": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_hora_resposta": "2019-08-24T14:15:22Z",
"ultimo_nsu": 0,
"max_nsu": 0,
"documentos": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"nsu": 0,
"schema": "string",
"tipo_documento": "nota",
"chave_acesso": "string",
"resumo": true,
"tipo_evento": "string",
"numero_sequencial": 0,
"data_evento": "2019-08-24T14:15:22Z",
"data_recebimento": "2019-08-24T14:15:22Z",
"numero_protocolo": "string",
"tipo_nfe": 0,
"valor_nfe": 0,
"digest_value": "string",
"emitente_cpf_cnpj": "string",
"emitente_nome_razao_social": "string",
"emitente_inscricao_estadual": "string"
}
]
}

Consultar documento

Utilize esse endpoint para obter as informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.

Authorizations:

oauth2

path Parameters

required

string

ID único do documento gerado pela API.

Responses

Response Schema: application/json

id required	string ID único gerado pela API para identificar o documento.
created_at	string <date-time> Data/hora em que o documento foi criado na API. Representado no formato `ISO 8601`.
nsu	integer or null <int64> NSU do documento fiscal.
schema required	string Identificação do Schema XML que será utilizado para validar o XML existente no conteúdo da tag docZip. Vai identificar o tipo do documento e sua versão. Exemplos: resNFe_v1.00.xsd, procNFe_v3.10.xsd, resEvento_1.00.xsd, procEventoNFe_v1.00.xsd.
tipo_documento	string or null Enum: "nota" "evento" Tipo do documento de interesse da pessoa ou empresa.
chave_acesso	string or null Chave de Acesso da NF-e.
resumo	boolean or null Indica se o documento distribuído está em sua forma resumida.
tipo_evento	string or null Tipo do evento.
numero_sequencial	integer or null Número sequencial do evento para o mesmo tipo de evento.
data_evento	string or null <date-time> Data e hora do evento.
data_recebimento	string or null <date-time> Data e hora de autorização do evento.
numero_protocolo	string or null Número do protocolo de autorização.
tipo_nfe	integer or null Tipo da NF-e (0 - entrada; 1 - saída).
valor_nfe	number or null Valor total da NF-e.
digest_value	string or null Digest Value da NF-e processada. Utilizado para conferir a integridade da NF-e original.
emitente_cpf_cnpj	string or null CPF/CNPJ do emitente.
emitente_nome_razao_social	string or null Nome ou Razão Social do emitente.
emitente_inscricao_estadual	string or null Inscrição Estadual do emitente.

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"nsu": 0,
"schema": "string",
"tipo_documento": "nota",
"chave_acesso": "string",
"resumo": true,
"tipo_evento": "string",
"numero_sequencial": 0,
"data_evento": "2019-08-24T14:15:22Z",
"data_recebimento": "2019-08-24T14:15:22Z",
"numero_protocolo": "string",
"tipo_nfe": 0,
"valor_nfe": 0,
"digest_value": "string",
"emitente_cpf_cnpj": "string",
"emitente_nome_razao_social": "string",
"emitente_inscricao_estadual": "string"
}

Consultar manifestação

Consulta os detalhes de uma manifestação de NF-e já existente. Forneça o ID único obtido de uma requisição de manifestação ou de listagem de manifestações e a API irá retornar as informações da manifestação correspondente.

Authorizations:

oauth2

path Parameters

required

string

ID único da manifestação gerado pela API.

Responses

Response Schema: application/json

id	string ID único gerado pela API para este evento.
created_at	string <date-time> Data/hora em que o evento foi criado na API. Representado no formato `ISO 8601`.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
cpf_cnpj_autor	string CPF/CNPJ do autor do evento.
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
tipo_evento	string Tipo do evento vinculado.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer or null Sequencial do evento para o mesmo tipo de evento.
justificativa	string or null Justificativa para o desconhecimento ou não-realização da operação.
data_registro	string or null <date-time> Data e hora do registro do evento pela SEFAZ.
codigo_status	integer or null Código do status de registro do evento.
motivo_status	string or null Descrição literal do status do registro do evento.
numero_protocolo	string or null Número do Protocolo de registro do evento.

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"status": "pendente",
"cpf_cnpj_autor": "string",
"chave_acesso": "string",
"tipo_evento": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"justificativa": "string",
"data_registro": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string"
}

Distribuir documentos

Este endpoint permite que o destinatário obtenha Documentos Fiscais Eletrônicos (DF-e) emitidos contra o seu CNPJ ou CPF ou que seja de seu interesse. A distribuição pode ser feita de três formas: dist-nsu, cons-nsu e cons-chave.

Formas de Consulta:

dist-nsu: Consulta pelo último NSU recebido.
cons-nsu: Consulta por um NSU específico.
cons-chave: Consulta pela chave de acesso da NF-e.

Retorno da Solicitação

A resposta da solicitação inclui a propriedade status no JSON, que pode ter os seguintes valores:

processando: A solicitação está em andamento.
concluido: A solicitação foi processada com sucesso.
erro: Ocorreu um erro no processamento da solicitação.

Se o status retornado for processando, significa que a solicitação está sendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá adotar um fluxo que consiste em requisitar periodicamente o endpoint consultar distribuição até que a API retorne o pedido com um status indicando o fim do processamento (concluido ou erro).

Informações adicionais:

Consumo: 1 unidade por documento distribuído (retornado) ou requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

cpf_cnpj required	string CPF ou CNPJ da empresa. Utilize o valor sem máscara.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
uf_autor	string or null Sigla da UF do autor.
tipo_consulta required	string Enum: "dist-nsu" "cons-nsu" "cons-chave" Tipo de consulta. Valores possíveis: `dist-nsu` - Consulta pelo último NSU recebido. `cons-nsu` - Consulta por um NSU específico. `cons-chave` - Consulta pela chave de acesso da NF-e.
dist_nsu	integer or null <int64> Distribuição de conjunto de DF-e a partir do NSU informado. Obrigatório quando "tipo_consulta" for "dist-nsu".
cons_nsu	integer or null <int64> Consulta DF-e vinculado ao NSU informado. Obrigatório quando "tipo_consulta" for "cons-nsu".
cons_chave	string or null Consulta de NF-e por chave de acesso informada. Obrigatório quando "tipo_consulta" for "cons-chave".
ignorar_tempo_espera	boolean Default: false Deve ser utilizado em situações em que o cliente deseja ignorar o intervalo mínimo de 1 hora entre pedidos de distribuição de NF-e. Quando habilitado, o cliente reconhece os riscos associados, incluindo o bloqueio do CNPJ no Ambiente Nacional da SEFAZ, caso seja caracterizado consumo indevido. Valores: `false`: Respeita a regra de intervalo mínimo de 1 hora entre consultas quando não há mais documentos disponíveis. `true`: Ignora o tempo de espera e força a requisição.

Responses

Response Schema: application/json

id required	string ID único gerado pela API para o pedido de distribuição.
created_at	string <date-time> Data/hora em que o pedido foi criado na API. Representado no formato `ISO 8601`.
status required	string Enum: "processando" "concluido" "erro" Indica o status da distribuição.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
uf_autor	string or null Sigla da UF do autor.
tipo_consulta required	string Enum: "dist-nsu" "cons-nsu" "cons-chave"
dist_nsu	integer or null <int64> Distribuição de conjunto de DF-e a partir do NSU informado. Obrigatório quando `tipo_consulta` for `distNSU`.
cons_nsu	integer or null <int64> Consulta DF-e vinculado ao NSU informado. Obrigatório quando `tipo_consulta` for `consNSU`.
cons_chave	string or null Consulta de NF-e por chave de acesso informada. Obrigatório quando `tipo_consulta` for `consChNFe`.
codigo_status required	integer or null Código do status de processamento da requisição.
motivo_status	string or null Descrição do status de processamento da requisição.
data_hora_resposta required	string or null <date-time> Data e Hora de processamento da requisição.
ultimo_nsu required	integer or null <int64> Último NSU pesquisado no Ambiente Nacional. Se for o caso, o solicitante pode continuar a consulta a partir deste NSU para obter novos resultados.
max_nsu required	integer or null <int64> Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.
	Array of objects (DistribuicaoNfeDocumento) <= 50 items Conjunto de informações resumidas e documentos fiscais eletrônicos de interesse da pessoa ou empresa.

Request samples

Payload

Content type

application/json

{"cpf_cnpj": "string",
"ambiente": "homologacao",
"uf_autor": "string",
"tipo_consulta": "dist-nsu",
"dist_nsu": 0,
"cons_nsu": 0,
"cons_chave": "string",
"ignorar_tempo_espera": false
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"ambiente": "homologacao",
"uf_autor": "string",
"tipo_consulta": "dist-nsu",
"dist_nsu": 0,
"cons_nsu": 0,
"cons_chave": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_hora_resposta": "2019-08-24T14:15:22Z",
"ultimo_nsu": 0,
"max_nsu": 0,
"documentos": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"nsu": 0,
"schema": "string",
"tipo_documento": "nota",
"chave_acesso": "string",
"resumo": true,
"tipo_evento": "string",
"numero_sequencial": 0,
"data_evento": "2019-08-24T14:15:22Z",
"data_recebimento": "2019-08-24T14:15:22Z",
"numero_protocolo": "string",
"tipo_nfe": 0,
"valor_nfe": 0,
"digest_value": "string",
"emitente_cpf_cnpj": "string",
"emitente_nome_razao_social": "string",
"emitente_inscricao_estadual": "string"
}
]
}

Listar distribuições

Retorna a lista de distribuições de NF-e de acordo com os critérios de busca utilizados. As distribuições são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada. Utilize o valor sem máscara.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao

Responses

Response Schema: application/json

@count	integer
	Array of objects (DistribuicaoNfe)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"status": "processando",
"ambiente": "homologacao",
"uf_autor": "string",
"tipo_consulta": "dist-nsu",
"dist_nsu": 0,
"cons_nsu": 0,
"cons_chave": "string",
"codigo_status": 0,
"motivo_status": "string",
"data_hora_resposta": "2019-08-24T14:15:22Z",
"ultimo_nsu": 0,
"max_nsu": 0,
"documentos": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"nsu": 0,
"schema": "string",
"tipo_documento": "nota",
"chave_acesso": "string",
"resumo": true,
"tipo_evento": "string",
"numero_sequencial": 0,
"data_evento": "2019-08-24T14:15:22Z",
"data_recebimento": "2019-08-24T14:15:22Z",
"numero_protocolo": "string",
"tipo_nfe": 0,
"valor_nfe": 0,
"digest_value": "string",
"emitente_cpf_cnpj": "string",
"emitente_nome_razao_social": "string",
"emitente_inscricao_estadual": "string"
}
]
}
]
}

Listar documentos

Retorna a lista de documentos fiscais eletrônicos de interesse da pessoa ou empresa de acordo com os critérios de busca utilizados. Os documentos são retornadas ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada. Utilize o valor sem máscara.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
dist_nsu	integer <int64> Filtrar por documentos a partir do NSU informado.
tipo_documento	string Filtrar pelo tipo do documento de interesse da pessoa ou empresa. Valores aceitos: `nota`, `evento`
forma_distribuicao	string Filtrar por documentos que foram distribuídos em sua forma resumida ou completa. Valores aceitos: `resumida`, `completa`
chave_acesso	string Filtrar pela chave de acesso da NF-e.

Responses

Response Schema: application/json

@count	integer
	Array of objects (DistribuicaoNfeDocumento)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"nsu": 0,
"schema": "string",
"tipo_documento": "nota",
"chave_acesso": "string",
"resumo": true,
"tipo_evento": "string",
"numero_sequencial": 0,
"data_evento": "2019-08-24T14:15:22Z",
"data_recebimento": "2019-08-24T14:15:22Z",
"numero_protocolo": "string",
"tipo_nfe": 0,
"valor_nfe": 0,
"digest_value": "string",
"emitente_cpf_cnpj": "string",
"emitente_nome_razao_social": "string",
"emitente_inscricao_estadual": "string"
}
]
}

Listar Manifestações

Retorna a lista de manifestações de NF-e de acordo com os critérios de busca utilizados. As manifestações são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ do autor do evento. Utilize o valor sem máscara.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao

Responses

Response Schema: application/json

@count	integer
	Array of objects (DistribuicaoNfeEvento)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"status": "pendente",
"cpf_cnpj_autor": "string",
"chave_acesso": "string",
"tipo_evento": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"justificativa": "string",
"data_registro": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string"
}
]
}

Listar notas sem manifestação

No processo de distribuição de DF-e, as notas fiscais eletrônicas (NF-e) são inicialmente disponibilizadas de forma resumida. Para obter o XML completo, o destinatário deve manifestar a ciência da operação e, posteriormente, uma manifestação conclusiva dentro de um prazo legal.

Para facilitar essa gestão e o cumprimento dos prazos legais de manifestação, a API permite listar as notas que ainda não possuem manifestação, ajudando os usuários a identificar rapidamente as notas que necessitam de ação.

O usuário pode optar por listar apenas as notas que não possuem manifestação conclusiva ou que não possuem qualquer tipo de manifestação. Essa flexibilidade permite um controle mais preciso e adequado às necessidades operacionais de cada empresa.

Os documentos são retornados ordenados decrescentemente pela data de distribuição, permitindo uma visualização clara e organizada das notas mais recentes.

Cenários de uso:

Identificar rapidamente as notas que ainda precisam de manifestação para obter o XML completo.
Listar todas as notas fiscais eletrônicas que foram registradas com ciência da operação, mas ainda não possuem uma manifestação conclusiva (confirmação da operação, desconhecimento da operação ou operação não realizada).
Listar todas as notas fiscais eletrônicas que não possuem nenhum tipo de manifestação registrada (nem ciência da operação, nem manifestação conclusiva).

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada. Utilize o valor sem máscara.
ambiente required	string Identificação do Ambiente. Valores aceitos: homologacao, producao
conclusiva	boolean Default: false Indica se serão consideradas apenas as manifestações conclusivas. Valores: `false`: serão retornadas notas que não possuírem qualquer tipo de manifestação. `true`: apenas as notas que não possuírem manifestação conclusiva serão retornadas. Ou seja, notas que tenham sido manifestadas apenas com Ciência da Operação (210210) continuarão sendo retornadas por esse endpoint até que recebam uma manifestação conclusiva.

Responses

Response Schema: application/json

@count	integer
	Array of objects (DistribuicaoNfeNota)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"chave_acesso": "string",
"numero_protocolo": "string",
"tipo_nfe": 0,
"data_emissao": "2019-08-24T14:15:22Z",
"valor_nfe": 0,
"digest_value": "string",
"emitente_cpf_cnpj": "string",
"emitente_nome_razao_social": "string",
"emitente_inscricao_estadual": "string"
}
]
}

Manifestar nota

O processo de manifestação do destinatário permite que os destinatários de Notas Fiscais Eletrônicas (NF-e) registrem formalmente sua posição em relação às operações descritas nesses documentos fiscais. Ele envolve eventos que indicam se a operação foi confirmada, desconhecida ou não realizada.

Os seguintes tipos de manifestação são suportados pela NF-e:

Confirmação da Operação (210200): Manifestação do destinatário confirmando que a operação descrita na NF-e ocorreu exatamente como informado na NF-e. Esse evento libera a possibilidade de download da NF-e pelo destinatário e impede que a empresa emitente cancele a NF-e após a confirmação.
Ciência da Operação (210210): Declara que o destinatário tem ciência da existência da NF-e, mas ainda não possui elementos suficientes para manifestar-se conclusivamente. Este é um evento opcional que pode ser usado pelo destinatário para indicar que está ciente da NF-e enquanto coleta mais informações. Esse evento libera a possibilidade de download da NF-e pelo destinatário.
Desconhecimento da Operação (210220): Manifestação do destinatário declarando que a operação descrita da NF-e não foi por ele solicitada.
Operação não Realizada (210240): Manifestação do destinatário reconhecendo sua participação na operação descrita na NF-e, mas declarando que a operação não ocorreu ou não se efetivou como informado nesta NF-e.

Informações adicionais:

Consumo: 1 unidade por requisição.

Authorizations:

oauth2

Request Body schema: application/json
required

Contém os dados do pedido para manifestação do destinatário.

cpf_cnpj required	string CPF ou CNPJ do autor do evento. Utilize o valor sem máscara.
ambiente required	string Enum: "homologacao" "producao" Identificação do Ambiente.
chave_acesso required	string Chave de Acesso da NF-e.
tipo_evento required	string Tipo do evento de manifestação do destinatário. Valores disponíveis: `210200` - Confirmação da operação; `210210` - Ciência da operação; `210220` - Desconhecimento da operação; `210240` - Operação não realizada.
justificativa	string or null [ 15 .. 255 ] characters Justificativa para o desconhecimento ou não-realização da operação. Nota: Campo obrigatório para o evento `210240` (operação não realizada).

Responses

Response Schema: application/json

id	string ID único gerado pela API para este evento.
created_at	string <date-time> Data/hora em que o evento foi criado na API. Representado no formato `ISO 8601`.
ambiente	string Enum: "homologacao" "producao" Identificação do ambiente.
status	string Enum: "pendente" "registrado" "rejeitado" "erro" Status do Evento.
cpf_cnpj_autor	string CPF/CNPJ do autor do evento.
chave_acesso	string Chave de Acesso do documento vinculado ao evento.
tipo_evento	string Tipo do evento vinculado.
data_evento	string <date-time> Data e hora do Evento.
numero_sequencial	integer or null Sequencial do evento para o mesmo tipo de evento.
justificativa	string or null Justificativa para o desconhecimento ou não-realização da operação.
data_registro	string or null <date-time> Data e hora do registro do evento pela SEFAZ.
codigo_status	integer or null Código do status de registro do evento.
motivo_status	string or null Descrição literal do status do registro do evento.
numero_protocolo	string or null Número do Protocolo de registro do evento.

Request samples

Payload

Content type

application/json

{"cpf_cnpj": "string",
"ambiente": "homologacao",
"chave_acesso": "string",
"tipo_evento": "string",
"justificativa": "stringstringstr"
}

Response samples

Content type

application/json

{"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"ambiente": "homologacao",
"status": "pendente",
"cpf_cnpj_autor": "string",
"chave_acesso": "string",
"tipo_evento": "string",
"data_evento": "2019-08-24T14:15:22Z",
"numero_sequencial": 0,
"justificativa": "string",
"data_registro": "2019-08-24T14:15:22Z",
"codigo_status": 0,
"motivo_status": "string",
"numero_protocolo": "string"
}

CEP

Consultar endereço através do CEP

Informações adicionais:

Consumo: 0,1 unidade requisição.
Em sandbox, a consulta é permitida somente para os seguintes CEP: 18270000 Tatuí/SP 01310300 São Paulo/SP 22010000 Rio de Janeiro/RJ 80020130 Curitiba/PR

Authorizations:

oauth2

path Parameters

Cep

required

string

CEP sem máscara.

Responses

Response Schema: application/json

bairro	string
cep	string
codigo_ibge	string
complemento	string
logradouro	string
municipio	string
tipo_logradouro	string
uf	string

Response samples

Content type

application/json

{"bairro": "string",
"cep": "string",
"codigo_ibge": "string",
"complemento": "string",
"logradouro": "string",
"municipio": "string",
"tipo_logradouro": "string",
"uf": "string"
}

CNPJ

Consultar dados do CNPJ

Informações adicionais:

Consumo: 0,1 unidade por requisição.
Em sandbox, a consulta é permitida somente para os seguintes CNPJ: 18760540000139 00038166000105 00394460000141 29979036000140

Authorizations:

oauth2

path Parameters

Cnpj

required

string

CNPJ sem máscara.

Responses

Response Schema: application/json

cnpj	string Número de inscrição do CNPJ.
razao_social	string Nome empresarial da pessoa jurídica.
nome_fantasia	string Corresponde ao nome fantasia.
data_inicio_atividade	string <date> Data de início da atividade.
matriz	boolean Indicador de matriz/filial: `true` - É matriz `false` - É filial
	object (CnpjNaturezaJuridica) Natureza jurídica.
capital_social	number Capital social da empresa.
	object (CnpjPorteEmpresa) Porte da empresa.
ente_federativo_responsavel	string O ente federativo responsável é preenchido para os casos de órgãos e entidades do grupo de natureza jurídica 1XXX. Para as demais naturezas, este atributo fica em branco.
	object (CnpjSituacaoCadastral) Situação cadastral.
	object (CnpjMotivoSituacaoCadastral) Motivo da situação cadastral.
nome_da_cidade_no_exterior	string Nome da cidade no exterior.
	object (CnpjPais) País.
	object (CnpjCnae) Atividade econômica principal do estabelecimento.
	Array of objects (CnpjCnaeSecundario)
	object (CnpjEndereco) Endereço do estabelecimento.
	Array of objects (CnpjTelefone)
email	string E-mail do contribuinte.
	object (CnpjSituacaoEspecial) Situação especial da empresa.
	object (CnpjOpcaoSimples) Informações da opção do Simples Nacional.
	object (CnpjOpcaoSimei) Informações da opção pelo MEI.
	Array of objects (CnpjSocio)

Response samples

Content type

application/json

{"cnpj": "string",
"razao_social": "string",
"nome_fantasia": "string",
"data_inicio_atividade": "2019-08-24",
"matriz": true,
"natureza_juridica": {"codigo": "string",
"descricao": "string"
},
"capital_social": 0,
"porte": {"codigo": "string",
"descricao": "string"
},
"ente_federativo_responsavel": "string",
"situacao_cadastral": {"data": "2019-08-24",
"codigo": "string",
"descricao": "string"
},
"motivo_situacao_cadastral": {"data": "2019-08-24",
"codigo": "string",
"descricao": "string"
},
"nome_da_cidade_no_exterior": "string",
"pais": {"codigo": "string",
"descricao": "string"
},
"atividade_principal": {"codigo": "string",
"descricao": "string"
},
"atividades_secundarias": [{"codigo": "string",
"descricao": "string"
}
],
"endereco": {"tipo_logradouro": "string",
"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"cep": "string",
"uf": "string",
"municipio": {"codigo_tom": "string",
"codigo_ibge": "string",
"descricao": "string"
}
},
"telefones": [{"ddd": "string",
"numero": "string"
}
],
"email": "string",
"situacao_especial": {"data": "2019-08-24",
"codigo": "string",
"descricao": "string"
},
"simples": {"optante": true,
"data_opcao": "2019-08-24",
"data_exclusao": "2019-08-24"
},
"simei": {"optante": true,
"data_opcao": "2019-08-24",
"data_exclusao": "2019-08-24"
},
"socios": [{"identificador_socio": {"codigo": "string",
"descricao": "string"
},
"nome": "string",
"cpf_cnpj": "string",
"qualificacao": {"codigo": "string",
"descricao": "string"
},
"data_entrada_sociedade": "2019-08-24",
"pais": {"codigo": "string",
"descricao": "string"
},
"representante_legal": {"cpf": "string",
"nome": "string",
"qualificacao": {"codigo": "string",
"descricao": "string"
}
},
"faixa_etaria": {"codigo": "string",
"descricao": "string"
}
}
]
}

Listar estabelecimentos ativos a partir da base de CNPJ

Retorna uma lista de estabelecimentos de acordo com os critérios de busca utilizados. Somente serão retornados estabelecimentos com situação cadastral "Ativa".

Informações adicionais:

Consumo: 0,1 unidade por estabelecimento listado ou requisição.
Em sandbox, a consulta de listagem de CNPJ não é permitida.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cnae_principal required	string Filtro pelo código CNAE da atividade principal do estabelecimento. Utilize o valor sem máscara.
municipio required	string Filtro pelo código IBGE ou TOM (Tabela de Órgãos e Municípios) do município do estabelecimento. Utilize o valor sem máscara.
natureza_juridica required	string Filtro pela natureza jurídica do estabelecimento Utilize o valor de quatro dígitos sem máscara.

Responses

Response Schema: application/json

@count	integer
	Array of objects (CnpjEmpresa)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"cnpj": "string",
"razao_social": "string",
"nome_fantasia": "string",
"data_inicio_atividade": "2019-08-24",
"matriz": true,
"natureza_juridica": {"codigo": "string",
"descricao": "string"
},
"capital_social": 0,
"porte": {"codigo": "string",
"descricao": "string"
},
"ente_federativo_responsavel": "string",
"situacao_cadastral": {"data": "2019-08-24",
"codigo": "string",
"descricao": "string"
},
"motivo_situacao_cadastral": {"data": "2019-08-24",
"codigo": "string",
"descricao": "string"
},
"nome_da_cidade_no_exterior": "string",
"pais": {"codigo": "string",
"descricao": "string"
},
"atividade_principal": {"codigo": "string",
"descricao": "string"
},
"atividades_secundarias": [{"codigo": "string",
"descricao": "string"
}
],
"endereco": {"tipo_logradouro": "string",
"logradouro": "string",
"numero": "string",
"complemento": "string",
"bairro": "string",
"cep": "string",
"uf": "string",
"municipio": {"codigo_tom": "string",
"codigo_ibge": "string",
"descricao": "string"
}
},
"telefones": [{"ddd": "string",
"numero": "string"
}
],
"email": "string",
"situacao_especial": {"data": "2019-08-24",
"codigo": "string",
"descricao": "string"
},
"simples": {"optante": true,
"data_opcao": "2019-08-24",
"data_exclusao": "2019-08-24"
},
"simei": {"optante": true,
"data_opcao": "2019-08-24",
"data_exclusao": "2019-08-24"
},
"socios": [{"identificador_socio": {"codigo": null,
"descricao": null
},
"nome": "string",
"cpf_cnpj": "string",
"qualificacao": {"codigo": null,
"descricao": null
},
"data_entrada_sociedade": "2019-08-24",
"pais": {"codigo": null,
"descricao": null
},
"representante_legal": {"cpf": null,
"nome": null,
"qualificacao": null
},
"faixa_etaria": {"codigo": null,
"descricao": null
}
}
]
}
]
}

Debug

Endpoints auxiliares voltados à análise técnica e depuração de documentos fiscais. Permitem rastrear o processamento de DF-es na API, incluindo o conteúdo original recebido e as requisições realizadas aos serviços autorizadores (SEFAZ, prefeituras, etc).

Corpo da requisição HTTP

Este endpoint retorna apenas o corpo da requisição HTTP enviada ao autorizador, preservando o conteúdo exatamente como foi armazenado pela API.

Informações retornadas:

Envelope SOAP da requisição, possivelmente compactado.

Cenários de uso:

Verificação do XML ou SOAP efetivamente enviado.
Encaminhamento ao suporte da SEFAZ ou prefeitura para análise.
Diagnóstico técnico do conteúdo de envio.

Authorizations:

oauth2

path Parameters

required

string

ID da requisição HTTP.

Responses

Response Schema: /

string <binary>

Corpo da resposta HTTP

Este endpoint retorna apenas o corpo da resposta HTTP recebida do autorizador, permitindo análise técnica da mensagem retornada pela SEFAZ ou prefeitura.

Informações retornadas:

Envelope SOAP da resposta, ou mensagem de erro (ex: HTML, XML), no formato original.

Cenários de uso:

Inspeção da resposta real retornada pelo autorizador.
Encaminhamento do conteúdo ao suporte técnico.
Diagnóstico de rejeições, falhas de processamento ou erros de infraestrutura.

Authorizations:

oauth2

path Parameters

required

string

ID da requisição HTTP.

Responses

Response Schema: /

string <binary>

Debug de DF-e

Este endpoint retorna informações detalhadas de debug sobre o processamento de um documento fiscal eletrônico (DFe), como NF-e, NFC-e, MDF-e, CT-e, NFS-e, dentre outros. Ele permite inspecionar o conteúdo original enviado à API e analisar todas as interações realizadas com os serviços autorizadores (SEFAZ ou prefeituras) durante o fluxo de emissão.

Informações retornadas:

JSON original recebido no momento da criação do documento.
Histórico das etapas de envio e consulta.
Status e mensagens retornadas pelo autorizador.

Cenários de uso:

Diagnóstico de falhas no processamento do documento.
Verificação da resposta da SEFAZ ou prefeitura.
Apoio ao suporte técnico e análise de integração.

Authorizations:

oauth2

path Parameters

required

string

ID único do documento fiscal gerado pela API.

Responses

Response Schema: application/json

id	string Identificador do documento fiscal.
tipo	string Tipo do documento: nfe, nfce, mdfe, nfse, etc.
created_at	string <date-time> Data e hora da criação do documento, representada no formato UTC (Tempo Universal Coordenado). O valor é retornado no padrão ISO 8601, incluindo o deslocamento de fuso horário 'Z' no final. Exemplo: "2025-04-15T14:16:47.775Z"
	Array of objects (DfeRequisicaoDebug) Lista de requisições feitas ao autorizador durante o processamento.

Response samples

Content type

application/json

{"id": "string",
"tipo": "string",
"created_at": "2019-08-24T14:15:22Z",
"requisicoes": [{"created_at": "2019-08-24T14:15:22Z",
"tipo": "string",
"lote_id": "string",
"codigo_status": 0,
"motivo_status": "string",
"http_request": {"id": "string",
"method": "string",
"uri": "string",
"headers": "string",
"response_status_code": 0,
"response_status_reason": "string",
"response_headers": "string",
"response_time": 0
}
}
]
}

Payload original recebido

Este endpoint retorna o conteúdo original recebido pela API no momento da criação do documento fiscal.

Cenários de uso:

Inspeção detalhada dos dados enviados à API.
Verificação de divergências entre o payload fornecido e o processado.
Encaminhamento do conteúdo original ao suporte da API.

Authorizations:

oauth2

path Parameters

required

string

ID do documento fiscal gerado pela API.

Responses

Response Schema: /

string <binary>

E-mail

Consultar e-mail

Obtém informações detalhadas sobre o envio de um email. Este endpoint permite rastrear todos os eventos relacionados ao email, como envio, entrega, falhas e outros eventos relevantes.

Com este endpoint, é possível ter uma visão completa do ciclo de vida de um email enviado, permitindo que os usuários acompanhem e analisem o status e o histórico de eventos do email. Isso é particularmente útil para identificar problemas de entrega e entender o comportamento do email ao longo do tempo.

Authorizations:

oauth2

path Parameters

required

string

ID único do e-mail.

Esse parâmetro é obtido após o envio do email por qualquer endpoint da API que realize disparos de email.

Exemplos:

Envio de XML e PDF de NF-e.
Envio de XML e PDF de NFC-e.

Responses

Response Schema: application/json

id required	string ID único gerado pela API para este email. Utilize-o no endpoint de consulta de email para obter informações detalhadas sobre o envio do email e rastrear todos os eventos relacionados, como envio, entrega, falhas e outros eventos relevantes.
status	string Enum: "pending" "sending" "sent" "delivered" "delivery_delayed" "bounced" "complained" "rejected" "cancelled" "failed"
sent_at	string or null <date-time>
to	Array of strings
cc	Array of strings
reply_to	string
subject	string
	Array of objects (EmailAttachment)
	Array of objects (EmailEvent)

Response samples

Content type

application/json

{"id": "string",
"status": "pending",
"sent_at": "2019-08-24T14:15:22Z",
"to": ["string"
],
"cc": ["string"
],
"reply_to": "string",
"subject": "string",
"attachments": [{"content_type": "string",
"filename": "string"
}
],
"events": [{"id": "string",
"event_type": "string",
"timestamp": "2019-08-24T14:15:22Z",
"message": "string"
}
]
}

Listar e-mails

Retorna a lista dos emails associadas à sua conta. Os e-emails são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.

Authorizations:

oauth2

query Parameters

$top	integer Default: 10 Limite no número de objetos a serem retornados pela API, entre 1 e 100.
$skip	integer Default: 0 Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
$inlinecount	boolean Default: false Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
cpf_cnpj required	string Filtra pelo CPF ou CNPJ da empresa. Utilize o valor sem máscara.
undelivered	boolean Filtra apenas emails com problemas de entrega.
email	string Filtra pelo endereço de e-mail do destinatário para qual o email foi enviado.

Responses

Response Schema: application/json

@count	integer
	Array of objects (EmailResumo)

Response samples

Content type

application/json

{"@count": 0,
"data": [{"id": "string",
"status": "pending",
"sent_at": "2019-08-24T14:15:22Z",
"recipients": ["string"
],
"subject": "string"
}
]
}

ACBr API (3.1.18)

Conta

Consultar o extrato de movimentação de créditos do tenant atual.

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Consultar o limite de uso e o consumo de uma cota específica.

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Consultar o resumo da cota de créditos pré-pagos.

Authorizations:

Responses

Response Schema: application/json

Response samples

Consultar os limites de uso e consumo das cotas disponíveis, exceto a cota de créditos pré-pagos. Deprecated

Authorizations:

Responses

Response Schema: application/json

Response samples

Empresa

Alterar configuração de CT-e

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Alterar configuração de CT-e OS

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Alterar configuração de DC-e

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Alterar configuração de Distribuição de NF-e

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Alterar configuração de MDF-e

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Alterar configuração de NF-e

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Alterar configuração de NFC-e

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Response Schema: /

Request Body schema: application/json
required

Request Body schema: application/json
required