| Método | URL |
|---|---|
https://BASE_URL/public/v1/recebiveis/lotes/{idLote}/lastros/nfe |
Anexa arquivos XML de NF-e como lastros de títulos de um lote.
O endpoint cria uma "fotografia" da sessão de importação, persistindo o resultado individual de cada arquivo (Vinculado / Pendente de vínculo / Rejeitado). Use os idsLogIntegracao retornados aqui para consultar o detalhamento via GET /public/v1/recebiveis/lotes/{idLote}/lastros/importacao/{idLogIntegracao}.
Path Params¶
| Campo | Tipo | Descrição |
|---|---|---|
idLote | Número | Identificador do lote. |
Request Body¶
A requisição deve ser enviada como multipart/form-data.
| Campo | Tipo | Descrição |
|---|---|---|
arquivo | Lista de arquivos | Um ou mais arquivos XML de NF-e. |
Exemplo de cURL
curl -X POST "https://BASE_URL/public/v1/recebiveis/lotes/987/lastros/nfe" \
-H "Authorization: Bearer {token}" \
-H "GrupoEconomico: {grupo}" \
-H "TipoUsuario: Cedente" \
-F "arquivo=@/caminho/para/nota-fiscal-1.xml" \
-F "arquivo=@/caminho/para/nota-fiscal-2.xml"
Response Body — 200 OK
{
"status": "sucesso",
"mensagem": "Lastro anexado com sucesso.",
"idsLogIntegracao": [44570, 44571]
}
Anexar via Base64 (JSON)¶
| Método | URL |
|---|---|
https://BASE_URL/public/v1/recebiveis/lotes/{idLote}/lastros/nfe/base64 |
Alternativa ao envio via multipart/form-data. Anexa o mesmo tipo de lastro (XML de NF-e), porém com o conteúdo do arquivo codificado em base64 no corpo da requisição. Cada chamada aceita um único arquivo.
Path Params¶
| Campo | Tipo | Descrição |
|---|---|---|
idLote | Número | Identificador do lote. |
Request Body¶
A requisição deve ser enviada como application/json.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nomeArquivo | Texto | Sim | Nome do arquivo, incluindo a extensão (máximo de 255 caracteres). |
conteudoBase64 | Texto | Sim | Conteúdo do arquivo XML da NF-e codificado em base64. |
Request Body
{
"nomeArquivo": "nfe_123.xml",
"conteudoBase64": "<base64>"
}
Exemplo de cURL
curl -X POST "https://BASE_URL/public/v1/recebiveis/lotes/987/lastros/nfe/base64" \
-H "Authorization: Bearer {token}" \
-H "GrupoEconomico: {grupo}" \
-H "Content-Type: application/json" \
-d '{
"nomeArquivo": "nfe_123.xml",
"conteudoBase64": "<base64>"
}'
Response Body — 200 OK
{
"status": "sucesso",
"mensagem": "Lastro anexado com sucesso."
}
Erros¶
Erros retornam HTTP 400 Bad Request com o envelope RetornoPadrao.
Response Body — 400 Bad Request (base64 inválido)
{
"status": "erro",
"mensagem": "O conteúdo do arquivo 'nfe_123.xml' não é um base64 válido."
}
Response Body — 400 Bad Request (conteúdo vazio)
{
"status": "erro",
"mensagem": "O conteúdo do arquivo 'nfe_123.xml' está vazio."
}
Response Body — 400 Bad Request (lote inexistente)
{
"status": "erro",
"mensagem": "Não foi possível identificar o lote 987."
}
Modelo de dados¶
Retorno¶
| Campo | Tipo | Descrição |
|---|---|---|
status | Texto | Status do processamento. |
mensagem | Texto | Mensagem retornada pela API. |
idsLogIntegracao | Lista de números | Identificadores de log de integração gerados — um por arquivo enviado. Use cada id no endpoint de consulta de fotografia para acompanhar o resultado individual. |