Confirmar Consulta Recebimento

{ "destino": "SAP", "payload": [ { "emitente_documento": "11.222.333/0001-44", "nf_entrada": "NF123456", "observacao": "Processada em lote" }, { "ag_documento": "12.345.678/0001-99", "nf_entrada": "NF789012", "observacao": "Processada em lote" } ] }

{ "status": 200, "message": "Processado", "destino": "SAP", "resultado": [ { "ok": true, "status": 200, "message": "Consumo confirmado", "data": { "ag_id": "b47043ef-8501-4dfd-b73c-1ab687f8ab6d", "ag_documento": "12.345.678/0001-99", "nf_entrada": "NF123456", "consumido_em": "2026-02-10T14:32:11", "consumido_por": "8d77c5b1-91a2-4c7a-bc77-3cfa92a111aa" } } ] }

Visão Geral

Registra a confirmação de consumo de notas fiscais de entrada por um sistema externo, garantindo que uma NF já consultada não seja retornada novamente em futuras consultas de recebimento.

Esse endpoint é utilizado após a leitura bem-sucedida das notas fiscais recebidas pelo AG, assegurando idempotência, rastreabilidade por integração e controle de processamento entre sistemas (ERP, TMS, WMS, BI, etc.).

Método HTTP: POST /v1/confirmar_consulta_recebimento

Nome	Valor
Content-Type	`application/json`
Authorization	`Bearer <token>`

Nome

Valor

Content-Type

application/json

Authorization

Bearer <token>

Nome	Tipo	Descrição
`destino`	string	Identificador do sistema consumidor (ex: SAP, TOTVS, ETC..)
`payload`	array	Lista de confirmações
`emitente_documento`	string	Documento (CNPJ/CPF) do Emitente a ser filtrado
`nf_entrada`	string	Número da NF recebida
`observacao`	observacao	Observação livre de auditoria

Nome

Tipo

Descrição

destino

string

Identificador do sistema consumidor (ex: SAP, TOTVS, ETC..)

payload

array

Lista de confirmações

emitente_documento

string

Documento (CNPJ/CPF) do Emitente a ser filtrado

nf_entrada

string

Número da NF recebida

observacao

observacao

Observação livre de auditoria

Exemplo

{
  "destino": "SAP",
  "payload": [
    {
      "emitente_documento": "11.222.333/0001-44",
      "nf_entrada": "NF123456",
      "observacao": "Processada em lote"
    },
    {
      "ag_documento": "12.345.678/0001-99",
      "nf_entrada": "NF789012",
      "observacao": "Processada em lote"
    }
  ]
}

{
  "status": 200,
  "message": "Processado",
  "destino": "SAP",
  "resultado": [
    {
      "ok": true,
      "status": 200,
      "message": "Consumo confirmado",
      "data": {
        "ag_id": "b47043ef-8501-4dfd-b73c-1ab687f8ab6d",
        "ag_documento": "12.345.678/0001-99",
        "nf_entrada": "NF123456",
        "consumido_em": "2026-02-10T14:32:11",
        "consumido_por": "8d77c5b1-91a2-4c7a-bc77-3cfa92a111aa"
      }
    }
  ]
}

Erros comuns

Código	Mensagem	Causa Provável
403	Usuário sem acesso a empresa	Sem vínculo com empresa
404	Nenhuma movimentação de entrada encontrada	NF já consumida
500	Erro interno	Violação de política RLS, chave duplicada etc

A confirmação de consulta somente será efetuada se a nota fiscal já tiver sido registrada previamente como ENTRADA no sistema. Caso contrário, a requisição será rejeitada.

Comece por aqui

WMS

AG CONTROL

Visão Geral

Headers

Campos

Exemplo

Erros comuns

​Visão Geral

​Headers

​Campos

​Exemplo

​Erros comuns

Visão Geral

Headers

Campos

Exemplo

Erros comuns