API ENUMs

This page details the predefined values (ENUMs) used across the Koncili API.

This documentation describes all enumerated types (ENUMs) used in the Marketplace API, including their possible values, descriptions, and related endpoints.

ENUM Overview

ENUMs are used to standardize:

Order statuses
Payment methods
Financial release types (lançamentos)
Classification of postings in the financial taxonomy
Other fields with predefined value sets

How to use

Always reference the exact values as documented below, including case sensitivity and underscores.

Important

When integrating with the API:

Consult this documentation for the accepted ENUM values for each endpoint.
Validate values before sending them to the API.
Implement proper handling for responses containing unknown or unexpected ENUMs.
Periodically update your implementation as new ENUM versions are released.

ENUM Descriptions

Order Status

ENUM Value	Description	Related Endpoints
`INVOICED`	Order has been invoiced	`POST /order` `GET /order` `POST /reconciliation`
`PAID_WAITING_DELIVERY`	Sent	`POST /order` `GET /order` `POST /reconciliation`
`CONCLUDED`	Delivered	`POST /order` `GET /order` `POST /reconciliation`
`CANCELED`	Order has been canceled	`POST /order` `GET /order` `POST /reconciliation`

Payment Methods

ENUM Value	Description	Related Endpoints
`IN_CASH`	One-time full payment (In cash)	`POST /order` `GET /order`

Financial Release Types

ENUM Value	Description	Related Endpoints
`COMISSION`	Sales commission	`POST /order` `GET /order` `POST /reconciliation`
`SHIP`	Shipping/Freight	`POST /order` `GET /order` `POST /reconciliation`
`RETURN_COMISSION`	Commission refund/reversal	`POST /order` `GET /order` `POST /reconciliation`
`RETURN_SHIP`	Shipping refund/reversal	`POST /order` `GET /order` `POST /reconciliation`
`SALE`	Direct sale	`POST /order` `GET /order` `POST /reconciliation`
`ADJUSTMENT`	Adjustment	`POST /order` `GET /order` `POST /reconciliation`

Financial Taxonomy

The financial taxonomy classifies every posting into four nested levels, derived from the settlement type (extractType) of the posting itself. The four fields are always returned, and always filled in, by:

JSON field	Level	What it represents	ENUM value	Returned label (en)
`functionGrouper`	L0 — Function Grouper	Broadest nature of the posting: revenue, expense, other or legacy	`REVENUE_ROOT`	Revenue
`financialFunction`	L1 — Financial Function	Role of the posting within the grouper, for example revenue vs. revenue reduction	`REVENUE`	Revenue
`financialGrouping`	L2 — Financial Grouping	Anchor level: uniquely identifies the classification and determines the other three	`REVENUE_SALE`	Revenue - Sale
`category`	L3 — Category	Accounting nature of the posting: sale, commission, shipping, tax and the like	`SALE`	Sale

Values translated according to the language

Just like the description field of the settlement type, the four taxonomy fields are translated: the API returns the label in the language of the request, not the ENUM value. The tables on this page list the ENUM because it is the canonical enumeration of the taxonomy — what travels in the JSON is the matching label, shown in the "Returned label (en)" column.

When no translation is registered for a value, the API returns the translation key itself: taxonomy.<VALUE> for L0, L1 and L2, and taxonomyCategory.<VALUE> for L3 — for example, taxonomy.FOO. Treat that shape as an unknown value.

How to use

The four taxonomy fields are meant for display and human reading: because they are translated, they must not be used as an integration key. For the automatic accounting mapping in your ERP, use the invariant technical codes — extractType on the items of unresolveds/concilieds, and code on releasetype.

It still holds that L2 is the anchor level: once you know the financial grouping, the other three levels are determined. The remaining fields spare you from the combination table when totalling at higher levels.

L0 — Function Grouper (`functionGrouper`)

ENUM value	Description	Returned label (en)
`REVENUE_ROOT`	Postings related to the seller revenue	Revenue
`EXPENSE_ROOT`	Postings related to expenses charged by the marketplace	Expense
`OTHER_ROOT`	Movements that are neither revenue nor expense (transfers, blocks, informational entries)	Others
`LEGACY_ROOT`	Types not yet reclassified into the current taxonomy	Legacy

L1 — Financial Function (`financialFunction`)

ENUM value	Grouper (L0)	Description	Returned label (en)
`REVENUE`	`REVENUE_ROOT`	Revenue — amount in favor of the seller	Revenue
`REVENUE_REDUCTION`	`REVENUE_ROOT`	Revenue reduction — refund or return that reduces revenue	Revenue Reduction
`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	Operating expense charged to the seller	Operational Expenses
`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	Expense compensation — refund of an expense charged previously	Expense Compensation
`OTHER_INCOMING`	`OTHER_ROOT`	Incoming amount that is not revenue	Others - Incoming
`OTHER_OUTGOING`	`OTHER_ROOT`	Outgoing amount that is not an expense	Others - Outgoing
`OTHER_NEUTRAL`	`OTHER_ROOT`	Neutral posting — neither incoming nor outgoing	Others
`LEGACY`	`LEGACY_ROOT`	Legacy classification, kept for types not yet reclassified	Legacy

L3 — Category (`category`)

ENUM value	Description	Returned label (en)
`SALE`	Product sale	Sale
`COMMISSION`	Commission charged by the marketplace	Commission
`SHIPPING`	Shipping and logistics	Shipping and Logistics
`CAMPAIGN`	Campaigns, coupons and promotional actions	Campaign
`TAX`	Taxes and duties	Taxes
`WITHHOLDING_AND_RELEASE`	Withholding and release of amounts	Withholdings and Releases
`PURCHASE`	Purchase of products or services from the marketplace	Purchases
`ANTICIPATION`	Receivables anticipation	Anticipations
`LEGAL`	Amounts of legal origin	Legal
`PENALTY`	Fines and penalties	Penalties
`NOTICE`	Informational posting	Informational
`SUBSCRIPTION`	Subscriptions and recurring fees	Subscription
`TRANSACTION`	Transfers and financial movements	Transactions
`OTHER`	Remaining postings	Others
`LEGACY`	Legacy category	Legacy

Valid combinations

Each Financial Grouping (L2) belongs to exactly one Financial Function, one Function Grouper and one Category. The table below lists every combination that exists today.

`financialGrouping` (L2)	`financialFunction` (L1)	`functionGrouper` (L0)	`category` (L3)	L2 label (en)
`REVENUE_SALE`	`REVENUE`	`REVENUE_ROOT`	`SALE`	Revenue - Sale
`REVENUE_SHIPPING`	`REVENUE`	`REVENUE_ROOT`	`SHIPPING`	Revenue - Shipping
`REVENUE_CAMPAIGN`	`REVENUE`	`REVENUE_ROOT`	`CAMPAIGN`	Revenue - Campaign
`REVENUE_TAX`	`REVENUE`	`REVENUE_ROOT`	`TAX`	Revenue - Taxes
`REVENUE_TRANSACTION`	`REVENUE`	`REVENUE_ROOT`	`TRANSACTION`	Revenue - Transactions
`REVENUE_OTHER`	`REVENUE`	`REVENUE_ROOT`	`OTHER`	Revenue - Others
`REVENUE_REDUCTION_SALE`	`REVENUE_REDUCTION`	`REVENUE_ROOT`	`SALE`	Revenue Reduction - Sale
`REVENUE_REDUCTION_SHIPPING`	`REVENUE_REDUCTION`	`REVENUE_ROOT`	`SHIPPING`	Revenue Reduction - Shipping
`REVENUE_REDUCTION_CAMPAIGN`	`REVENUE_REDUCTION`	`REVENUE_ROOT`	`CAMPAIGN`	Revenue Reduction - Campaign
`REVENUE_REDUCTION_TRANSACTION`	`REVENUE_REDUCTION`	`REVENUE_ROOT`	`TRANSACTION`	Revenue Reduction - Transactions
`REVENUE_REDUCTION_TAX`	`REVENUE_REDUCTION`	`REVENUE_ROOT`	`TAX`	Revenue Reduction - Taxes
`REVENUE_REDUCTION_OTHER`	`REVENUE_REDUCTION`	`REVENUE_ROOT`	`OTHER`	Revenue Reduction - Others
`EXPENSE_OPERATIONAL_COMMISSION`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`COMMISSION`	Expenses - Commission
`EXPENSE_OPERATIONAL_SHIPPING`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`SHIPPING`	Expenses - Shipping and Logistics
`EXPENSE_OPERATIONAL_CAMPAIGN`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`CAMPAIGN`	Expenses - Advertising and Campaigns
`EXPENSE_OPERATIONAL_TAX`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`TAX`	Expenses - Taxes
`EXPENSE_OPERATIONAL_PENALTY`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`PENALTY`	Expenses - Penalties
`EXPENSE_OPERATIONAL_PURCHASE`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`PURCHASE`	Expenses - Purchases
`EXPENSE_OPERATIONAL_ANTICIPATION`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`ANTICIPATION`	Expenses - Anticipations
`EXPENSE_OPERATIONAL_LEGAL`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`LEGAL`	Expenses - Legal
`EXPENSE_OPERATIONAL_SUBSCRIPTION`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`SUBSCRIPTION`	Expenses - Subscription
`EXPENSE_OPERATIONAL_OTHER`	`EXPENSE_OPERATIONAL`	`EXPENSE_ROOT`	`OTHER`	Expenses - Others
`EXPENSE_COMPENSATION_COMMISSION`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`COMMISSION`	Compensation - Commission
`EXPENSE_COMPENSATION_SHIPPING`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`SHIPPING`	Compensation - Shipping and Logistics
`EXPENSE_COMPENSATION_CAMPAIGN`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`CAMPAIGN`	Compensation - Advertising and Campaigns
`EXPENSE_COMPENSATION_TAX`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`TAX`	Compensation - Taxes
`EXPENSE_COMPENSATION_PENALTY`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`PENALTY`	Compensation - Penalties
`EXPENSE_COMPENSATION_PURCHASE`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`PURCHASE`	Compensation - Purchases
`EXPENSE_COMPENSATION_ANTICIPATION`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`ANTICIPATION`	Compensation - Anticipations
`EXPENSE_COMPENSATION_LEGAL`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`LEGAL`	Compensation - Legal
`EXPENSE_COMPENSATION_SUBSCRIPTION`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`SUBSCRIPTION`	Compensation - Subscription
`EXPENSE_COMPENSATION_OTHER`	`EXPENSE_COMPENSATION`	`EXPENSE_ROOT`	`OTHER`	Compensation - Others
`OTHER_INCOMING_TRANSFER`	`OTHER_INCOMING`	`OTHER_ROOT`	`TRANSACTION`	Transfers - Incoming
`OTHER_INCOMING_INFORMATION`	`OTHER_INCOMING`	`OTHER_ROOT`	`NOTICE`	Informational - Incoming
`OTHER_INCOMING_UNBLOCKING`	`OTHER_INCOMING`	`OTHER_ROOT`	`WITHHOLDING_AND_RELEASE`	Releases - Unblocking
`OTHER_INCOMING_OTHER`	`OTHER_INCOMING`	`OTHER_ROOT`	`OTHER`	Other Incoming
`OTHER_OUTGOING_TRANSFER`	`OTHER_OUTGOING`	`OTHER_ROOT`	`TRANSACTION`	Transfers - Outgoing
`OTHER_OUTGOING_INFORMATION`	`OTHER_OUTGOING`	`OTHER_ROOT`	`NOTICE`	Informational - Outgoing
`OTHER_OUTGOING_BLOCKING`	`OTHER_OUTGOING`	`OTHER_ROOT`	`WITHHOLDING_AND_RELEASE`	Withholdings - Blocking
`OTHER_OUTGOING_OTHER`	`OTHER_OUTGOING`	`OTHER_ROOT`	`OTHER`	Other Outgoing
`OTHER_NEUTRAL_OTHER`	`OTHER_NEUTRAL`	`OTHER_ROOT`	`OTHER`	Others
`LEGACY_V1`	`LEGACY`	`LEGACY_ROOT`	`LEGACY`	Others - Legacy

New values

New groupings may be created as new settlement types are mapped. Handle unknown values gracefully, as recommended at the top of this page.

Notification Types

ENUM Value	Description	Related Endpoints
`TEST_NOTIFICATION`	Registered URL test	`POST to the integrator's URL`
`ACCOUNT_CREATED`	Account created	`POST to the integrator's URL`
`RECONCILIATION_COMPLETED`	Reconciliation completed	`POST to the integrator's URL`
`BLOCKED_TEMPORARY`	Temporary block	`POST to the integrator's URL`
`BLOCKED_PERMANENT`	Permanent block	`POST to the integrator's URL`
`UNLOCKED`	Account unlocked	`POST to the integrator's URL`

ENUM Overview​

ENUM Descriptions​

Order Status​

Payment Methods​

Financial Release Types​

Financial Taxonomy​

L0 — Function Grouper (functionGrouper)​

L1 — Financial Function (financialFunction)​

L3 — Category (category)​

Valid combinations​

Notification Types​