Surcharge

Surcharge / tax / fee line (canonical breakdown)

typestring

Legacy provider-specific label (may duplicate code); prefer code and category for new clients

descriptionstring

Human-readable description from the provider

mandatoryboolean

Whether the surcharge is mandatory

includedboolean

When true, the amount is already included in the option total; when false, typically due at property

categorySurchargeCategory (string)

High-level grouping for a surcharge line

Possible values: [SURCHARGE_CATEGORY_UNSPECIFIED, TAX, FEE, DEPOSIT, OTHER]

codestring

Stable semantic code (e.g. property_fee, mandatory_tax). See surcharge vocabulary in docs.

Example: property_fee

price object

Price information. Three independent prices coexist: provider cost (net), provider retail (gross/suggested), and the org selling price (markupGross). The org margin configured per connection is applied on top of the provider gross, never on net. When no margin is configured, markupGross equals the provider gross.

netnumber<float>

Provider cost (what the agency pays the supplier).

currencystring

Currency code

bindingboolean

Provider binding flag. When true the provider gross/suggested is the minimum selling price and must be respected (cannot be sold below it).

suggestednumber<float>

Provider suggested retail / minimum selling price (preserved from provider, not overwritten by markup).

grossnumber<float>

Provider retail price before any org markup (falls back to net when the provider does not send a suggested price).

markupGrossnumber<float>

Customer selling price = provider gross + org margin. Equals the provider gross when no margin is configured.

markupNetnumber<float>

Provider net cost plus the org margin amount (mandatory field).

markupCurrencystring

Currency of the markup (usually same as currency)

markupBindingboolean

Indicates if the markup price must be respected (mandatory field).

marginAmountnumber<float>

Org margin amount applied on provider gross (markupGross - gross).

marginPercentnumber<float>

Effective margin percentage applied on provider gross.

marginTypestring

Type of margin applied - FIXED or PERCENTAGE

Surcharge

{
  "type": "string",
  "description": "string",
  "mandatory": true,
  "included": true,
  "category": "SURCHARGE_CATEGORY_UNSPECIFIED",
  "code": "property_fee",
  "price": {
    "net": 0,
    "currency": "string",
    "binding": true,
    "suggested": 0,
    "gross": 0,
    "markupGross": 0,
    "markupNet": 0,
    "markupCurrency": "string",
    "markupBinding": true,
    "marginAmount": 0,
    "marginPercent": 0,
    "marginType": "string"
  }
}