KernosDevelopers
Sair
Referência Recebimentos › Ler
Recebimentos › Ler

Lê um recebimento, com as linhas da nota e o que foi contado

GET/v1/objects/receipt/{id}

A quantidade esperada (qty_expected) e a divergência só aparecem para quem pode ver a nota: a conferência é às cegas para o operador.

Ação da chave: receipt.get

Quem cria a chave escolhe as ações que ela abre; sem esta, a rota recusa com api_key_action_not_granted.

Parâmetros do caminho

id string OBRIGATÓRIO

Parâmetros da consulta

source string

A origem da leitura, para o livro de recusas.

Devolve

O data do envelope { ok, data, error, error_code, field, trace_id }:

receipt objeto OBRIGATÓRIO
18 campos
depot_id uuid
divergence_units integer, ou nulo

Unidades a mais ou a menos que a nota. Nulo para quem confere às cegas.

dock_code string
id uuid
kind string

purchase para a nota do fornecedor, return para a devolução do cliente.

lines lista de objeto
16 campos
catch_weight boolean, ou nulo
description string
disposition string, ou nulo
disposition_reason string, ou nulo
divergent boolean, ou nulo
ean string, ou nulo
expires_on string, ou nulo
id uuid
lot_code string, ou nulo
nfe_unit string, ou nulo
photos lista de objeto
qty_counted integer, ou nulo
qty_expected integer, ou nulo

O que a nota diz. Nulo para quem confere às cegas.

seq integer
unit_mismatch boolean, ou nulo
weight_g integer, ou nulo
nfe_key string, ou nulo
order_ref string, ou nulo
receive_work_order_code string, ou nulo
receive_work_order_id uuid, ou nulo
return_reason string, ou nulo
sales_order_id uuid, ou nulo
short_code string, ou nulo
status string
supplier_cnpj string, ou nulo
supplier_name string, ou nulo
work_order_code string, ou nulo
work_order_id uuid, ou nulo

Recusas

HTTP 400 · Pedido mal formado

version_unknown HTTP 400A Kernos-Version pedida não existe. Use uma das versões declaradas no cabeçalho, ou não o mande.

HTTP 401 · Sem credencial válida

api_key_expired HTTP 401A chave venceu. Gire a chave no painel e use a nova.
api_key_wrong_environment HTTP 401A chave é do outro ambiente: ksk_test_ vai em https://stag.kernos.com.br, ksk_live_ em https://api.kernos.com.br.
unauthenticated HTTP 401Credencial ausente, inválida ou expirada.

HTTP 403 · Sem permissão

agent_token_out_of_scope HTTP 403O token de agente (kat_) só vale na porta MCP. Para a API, use o token de sessão ou uma chave de integração.
api_key_action_not_granted HTTP 403A chave não tem esta ação. Edite as ações da chave no painel.
api_key_out_of_scope HTTP 403A chave só vale nas rotas do contrato público.
depot_out_of_reach HTTP 403Quem chama não alcança o CD deste objeto. Peça alcance ao CD ou use outra credencial.
forbidden_role HTTP 403O papel de quem chama nesta empresa não permite esta ação.
module_not_subscribed HTTP 403A empresa não assina o módulo desta rota.
tenant_mismatch HTTP 403A credencial não pertence à empresa do endereço chamado.
tenant_unavailable HTTP 403A empresa está indisponível no momento.

HTTP 404 · Não encontrado

not_found HTTP 404Não existe objeto com esse identificador nesta empresa.

HTTP 429 · Muitos pedidos

rate_limited HTTP 429Muitos pedidos por segundo com esta chave. Espere o Retry-After, em segundos, e tente de novo.
curlNodePythonPHPJavaC#GoRust
Lê um recebimento, com as linhas da nota e o que foi contado
curl -X GET "https://stag.kernos.com.br/v1/objects/receipt/<id>" \
  -H "Authorization: Bearer ksk_test_…" \
  -H "Kernos-Version: 2026-10-03"
Resposta · 200 (a forma, sem dado real)
{
  "ok": true,
  "data": {
    "receipt": {
      "depot_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "divergence_units": 0,
      "dock_code": "…",
      "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "kind": "…",
      "lines": [
        {
          "catch_weight": true,
          "description": "…",
          "disposition": "…",
          "disposition_reason": "…",
          "divergent": true,
          "ean": "…",
          "expires_on": "…",
          "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
          "lot_code": "…",
          "nfe_unit": "…",
          "photos": [],
          "qty_counted": 0,
          "qty_expected": 0,
          "seq": 0,
          "unit_mismatch": true,
          "weight_g": 0
        }
      ],
      "nfe_key": "…",
      "order_ref": "…",
      "receive_work_order_code": "…",
      "receive_work_order_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "return_reason": "…",
      "sales_order_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "short_code": "…",
      "status": "…",
      "supplier_cnpj": "…",
      "supplier_name": "…",
      "work_order_code": "…",
      "work_order_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50"
    }
  },
  "error": null,
  "error_code": null,
  "field": null,
  "trace_id": null
}
Ambiente

ksk_test_ fala com https://stag.kernos.com.br; ksk_live_, com https://api.kernos.com.br. O prefixo da chave escolhe o endereço.