ENUMs da API

Nesta página, você encontrará os valores pré definidos (ENUMs) da API do Koncili.

---

Esta documentação descreve todos os tipos enumerados (ENUMs) utilizados na API Marketplace, incluindo seus valores possíveis, significados e endpoints relacionados.

Visão geral dos ENUMs

Os ENUMs são utilizados para padronizar:

• Status de pedidos
• Métodos de pagamento
• Tipos de lançamentos financeiros
• Classificação dos lançamentos na taxonomia financeira
• Outros campos com valores pré-definidos

Como utilizar

Sempre referencie os valores exatos como documentados abaixo, incluindo maiúsculas e underlines.

Importante

Ao integrar com a API:

• Consulte esta documentação para os valores ENUMs aceitos em cada endpoint
• Valide os valores antes de enviá-los à API
• Implemente tratamento adequado para respostas com ENUMs desconhecidos
• Atualize periodicamente sua implementação conforme novas versões dos ENUMs

Descrição dos ENUMs

Status de pedido

Valor ENUM	Descrição	Endpoints Relacionados
INVOICED	Pedido faturado	POST /order GET /order POST /reconciliation
PAID_WAITING_DELIVERY	Enviado	POST /order GET /order POST /reconciliation
CONCLUDED	Entregue	POST /order GET /order POST /reconciliation
CANCELED	Pedido cancelado	POST /order GET /order POST /reconciliation

Formas de pagamento

Valor ENUM	Descrição	Endpoints Relacionados
IN_CASH	Pagamento à vista	POST /order GET /order

Tipos de lançamentos financeiros

Valor ENUM	Descrição	Endpoints Relacionados
COMISSION	Comissão sobre venda	POST /order GET /order POST /reconciliation
SHIP	Frete	POST /order GET /order POST /reconciliation
RETURN_COMISSION	Devolução de comissão	POST /order GET /order POST /reconciliation
RETURN_SHIP	Devolução de frete	POST /order GET /order POST /reconciliation
SALE	Venda direta	POST /order GET /order POST /reconciliation
ADJUSTMENT	Ajuste	POST /order GET /order POST /reconciliation

Taxonomia financeira

A taxonomia financeira classifica cada lançamento em quatro níveis encaixados, derivados do tipo de repasse (extractType) do próprio lançamento. Os quatro campos são retornados, sempre preenchidos, por:

• GET /releasetype/{channelName}
• GET /orderextract/unresolveds
• GET /orderextract/concilieds
• PUT /orderextract/resolve/{id}

Campo JSON	Nível	O que representa	Valor ENUM	Rótulo retornado (pt-BR)
functionGrouper	Nv0 — Agrupador de Função	Natureza mais ampla do lançamento: receita, despesa, outros ou legado	REVENUE_ROOT	Receita
financialFunction	Nv1 — Função Financeira	Papel do lançamento dentro do agrupador, por exemplo receita x dedução de receita	REVENUE	Receita
financialGrouping	Nv2 — Agrupamento Financeiro	Nível âncora: identifica de forma única a classificação e determina os outros três	REVENUE_SALE	Receita - Venda
category	Nv3 — Categoria	Natureza contábil do lançamento: venda, comissão, frete, imposto e afins	SALE	Venda

Valores traduzidos conforme o idioma

Assim como o campo description do tipo de repasse, os quatro campos da taxonomia são traduzidos: a API devolve o rótulo no idioma da requisição, e não o valor ENUM. As tabelas desta página listam o ENUM porque ele é a enumeração canônica da taxonomia — o que trafega no JSON é o rótulo correspondente, mostrado na coluna "Rótulo retornado (pt-BR)".

Quando não há tradução cadastrada para um valor, a API devolve a própria chave de tradução: taxonomy.<VALOR> para Nv0, Nv1 e Nv2, e taxonomyCategory.<VALOR> para Nv3 — por exemplo, taxonomy.FOO. Trate esse formato como valor desconhecido.

Como usar

Os quatro campos da taxonomia são para exibição e leitura humana: por serem traduzidos, não servem como chave de integração. Para o de-para automático de classificação contábil no seu ERP, use os códigos técnicos invariantes — extractType nos itens de unresolveds/concilieds e code no releasetype.

Continua valendo que o Nv2 é o nível âncora: conhecendo o agrupamento financeiro, os outros três níveis ficam determinados. Os demais campos evitam que você precise da tabela de combinações para totalizar em níveis mais altos.

Nv0 — Agrupador de Função (functionGrouper)

Valor ENUM	Descrição	Rótulo retornado (pt-BR)
REVENUE_ROOT	Lançamentos ligados à receita do seller	Receita
EXPENSE_ROOT	Lançamentos ligados a despesas cobradas pelo marketplace	Despesa
OTHER_ROOT	Movimentações que não são receita nem despesa (transferências, bloqueios, informativos)	Outros
LEGACY_ROOT	Tipos ainda não reclassificados na taxonomia atual	Legado

Nv1 — Função Financeira (financialFunction)

Valor ENUM	Agrupador (Nv0)	Descrição	Rótulo retornado (pt-BR)
REVENUE	REVENUE_ROOT	Receita — valor a favor do seller	Receita
REVENUE_REDUCTION	REVENUE_ROOT	Dedução de receita — estorno ou devolução que reduz a receita	Redução de Receita
EXPENSE_OPERATIONAL	EXPENSE_ROOT	Despesa operacional cobrada do seller	Despesas Operacionais
EXPENSE_COMPENSATION	EXPENSE_ROOT	Compensação de despesa — estorno de uma despesa cobrada anteriormente	Compensação de Despesas
OTHER_INCOMING	OTHER_ROOT	Entrada de valor que não é receita	Outros - Entradas
OTHER_OUTGOING	OTHER_ROOT	Saída de valor que não é despesa	Outros - Saídas
OTHER_NEUTRAL	OTHER_ROOT	Lançamento neutro — nem entrada nem saída	Outros
LEGACY	LEGACY_ROOT	Classificação legada, mantida para tipos ainda não reclassificados	Legado

Nv3 — Categoria (category)

Valor ENUM	Descrição	Rótulo retornado (pt-BR)
SALE	Venda de produto	Venda
COMMISSION	Comissão cobrada pelo marketplace	Comissão
SHIPPING	Frete e logística	Frete e Logística
CAMPAIGN	Campanhas, cupons e ações promocionais	Campanha
TAX	Impostos e tributos	Impostos
WITHHOLDING_AND_RELEASE	Retenção e liberação de valores	Retenções e Liberações
PURCHASE	Compra de produtos ou serviços junto ao marketplace	Compras
ANTICIPATION	Antecipação de recebíveis	Antecipações
LEGAL	Valores de origem jurídica	Judicial
PENALTY	Multas e penalidades	Multas
NOTICE	Lançamento informativo	Informativos
SUBSCRIPTION	Assinaturas e mensalidades	Mensalidade
TRANSACTION	Transferências e movimentações financeiras	Transações
OTHER	Demais lançamentos	Outros
LEGACY	Categoria legada	Legado

Combinações válidas

Cada Agrupamento Financeiro (Nv2) pertence a exatamente uma Função Financeira, a um Agrupador de Função e a uma Categoria. A tabela abaixo traz todas as combinações existentes hoje.

financialGrouping (Nv2)	financialFunction (Nv1)	functionGrouper (Nv0)	category (Nv3)	Rótulo do Nv2 (pt-BR)
REVENUE_SALE	REVENUE	REVENUE_ROOT	SALE	Receita - Venda
REVENUE_SHIPPING	REVENUE	REVENUE_ROOT	SHIPPING	Receita - Frete
REVENUE_CAMPAIGN	REVENUE	REVENUE_ROOT	CAMPAIGN	Receita - Campanha
REVENUE_TAX	REVENUE	REVENUE_ROOT	TAX	Receita - Impostos
REVENUE_TRANSACTION	REVENUE	REVENUE_ROOT	TRANSACTION	Receita - Transações
REVENUE_OTHER	REVENUE	REVENUE_ROOT	OTHER	Receita - Outros
REVENUE_REDUCTION_SALE	REVENUE_REDUCTION	REVENUE_ROOT	SALE	Redução de Receita - Venda
REVENUE_REDUCTION_SHIPPING	REVENUE_REDUCTION	REVENUE_ROOT	SHIPPING	Redução de Receita - Frete
REVENUE_REDUCTION_CAMPAIGN	REVENUE_REDUCTION	REVENUE_ROOT	CAMPAIGN	Redução de Receita - Campanha
REVENUE_REDUCTION_TRANSACTION	REVENUE_REDUCTION	REVENUE_ROOT	TRANSACTION	Redução de Receita - Transações
REVENUE_REDUCTION_TAX	REVENUE_REDUCTION	REVENUE_ROOT	TAX	Redução de Receita - Impostos
REVENUE_REDUCTION_OTHER	REVENUE_REDUCTION	REVENUE_ROOT	OTHER	Redução de Receita - Outros
EXPENSE_OPERATIONAL_COMMISSION	EXPENSE_OPERATIONAL	EXPENSE_ROOT	COMMISSION	Despesas - Comissão
EXPENSE_OPERATIONAL_SHIPPING	EXPENSE_OPERATIONAL	EXPENSE_ROOT	SHIPPING	Despesas - Frete e Logística
EXPENSE_OPERATIONAL_CAMPAIGN	EXPENSE_OPERATIONAL	EXPENSE_ROOT	CAMPAIGN	Despesas - Propagandas e Campanhas
EXPENSE_OPERATIONAL_TAX	EXPENSE_OPERATIONAL	EXPENSE_ROOT	TAX	Despesas - Impostos
EXPENSE_OPERATIONAL_PENALTY	EXPENSE_OPERATIONAL	EXPENSE_ROOT	PENALTY	Despesas - Multas
EXPENSE_OPERATIONAL_PURCHASE	EXPENSE_OPERATIONAL	EXPENSE_ROOT	PURCHASE	Despesas - Compras
EXPENSE_OPERATIONAL_ANTICIPATION	EXPENSE_OPERATIONAL	EXPENSE_ROOT	ANTICIPATION	Despesas - Antecipações
EXPENSE_OPERATIONAL_LEGAL	EXPENSE_OPERATIONAL	EXPENSE_ROOT	LEGAL	Despesas - Judicial
EXPENSE_OPERATIONAL_SUBSCRIPTION	EXPENSE_OPERATIONAL	EXPENSE_ROOT	SUBSCRIPTION	Despesas - Mensalidade
EXPENSE_OPERATIONAL_OTHER	EXPENSE_OPERATIONAL	EXPENSE_ROOT	OTHER	Despesas - Outros
EXPENSE_COMPENSATION_COMMISSION	EXPENSE_COMPENSATION	EXPENSE_ROOT	COMMISSION	Compensação - Comissão
EXPENSE_COMPENSATION_SHIPPING	EXPENSE_COMPENSATION	EXPENSE_ROOT	SHIPPING	Compensação - Frete e Logística
EXPENSE_COMPENSATION_CAMPAIGN	EXPENSE_COMPENSATION	EXPENSE_ROOT	CAMPAIGN	Compensação - Propagandas e Campanhas
EXPENSE_COMPENSATION_TAX	EXPENSE_COMPENSATION	EXPENSE_ROOT	TAX	Compensação - Impostos
EXPENSE_COMPENSATION_PENALTY	EXPENSE_COMPENSATION	EXPENSE_ROOT	PENALTY	Compensação - Multas
EXPENSE_COMPENSATION_PURCHASE	EXPENSE_COMPENSATION	EXPENSE_ROOT	PURCHASE	Compensação - Compras
EXPENSE_COMPENSATION_ANTICIPATION	EXPENSE_COMPENSATION	EXPENSE_ROOT	ANTICIPATION	Compensação - Antecipações
EXPENSE_COMPENSATION_LEGAL	EXPENSE_COMPENSATION	EXPENSE_ROOT	LEGAL	Compensação - Judicial
EXPENSE_COMPENSATION_SUBSCRIPTION	EXPENSE_COMPENSATION	EXPENSE_ROOT	SUBSCRIPTION	Compensação - Mensalidade
EXPENSE_COMPENSATION_OTHER	EXPENSE_COMPENSATION	EXPENSE_ROOT	OTHER	Compensação - Outros
OTHER_INCOMING_TRANSFER	OTHER_INCOMING	OTHER_ROOT	TRANSACTION	Transferências - Entradas
OTHER_INCOMING_INFORMATION	OTHER_INCOMING	OTHER_ROOT	NOTICE	Informativos - Entradas
OTHER_INCOMING_UNBLOCKING	OTHER_INCOMING	OTHER_ROOT	WITHHOLDING_AND_RELEASE	Liberações - Desbloqueios
OTHER_INCOMING_OTHER	OTHER_INCOMING	OTHER_ROOT	OTHER	Outras Entradas
OTHER_OUTGOING_TRANSFER	OTHER_OUTGOING	OTHER_ROOT	TRANSACTION	Transferências - Saídas
OTHER_OUTGOING_INFORMATION	OTHER_OUTGOING	OTHER_ROOT	NOTICE	Informativos - Saídas
OTHER_OUTGOING_BLOCKING	OTHER_OUTGOING	OTHER_ROOT	WITHHOLDING_AND_RELEASE	Retenções - Bloqueios
OTHER_OUTGOING_OTHER	OTHER_OUTGOING	OTHER_ROOT	OTHER	Outras Saídas
OTHER_NEUTRAL_OTHER	OTHER_NEUTRAL	OTHER_ROOT	OTHER	Outros
LEGACY_V1	LEGACY	LEGACY_ROOT	LEGACY	Outros - Legado

Novos valores

Novos agrupamentos podem ser criados conforme novos tipos de repasse são mapeados. Trate valores desconhecidos de forma tolerante, como orientado no início desta página.

Tipos de notificação

Valor ENUM	Descrição	Endpoints Relacionados
TEST_NOTIFICATION	Teste da url cadastrada	POST na URL do integrador
ACCOUNT_CREATED	Conta criada	POST na URL do integrador
RECONCILIATION_COMPLETED	Conciliação finalizada	POST na URL do integrador
BLOCKED_TEMPORARY	Bloqueio temporário	POST na URL do integrador
BLOCKED_PERMANENT	Bloqueio permanente	POST na URL do integrador
UNLOCKED	Desbloqueio	POST na URL do integrador