Common objects

These are JSON object definitions and other JSON entities shared by operations across the API.

Time interval

When a time interval is used for filtering (for example in parameters such as CreatedUtc.StartUtc / CreatedUtc.EndUtc), the following rules apply:

• Start equals End (equality mode) If StartUtc and EndUtc are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:

  CreatedUtc == StartUtc

  This does not represent an interval; only records with CreatedUtc equal to that exact instant are returned.

• Start differs from End (interval mode) If StartUtc and EndUtc are different, the filter is evaluated as a half-open interval:

  StartUtc <= CreatedUtc < EndUtc

  In other words, the start is inclusive and the end is exclusive.

Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.

{
    "StartUtc": "2020-01-05T00:00:00Z",
    "EndUtc": "2020-01-10T00:00:00Z"
}

Property	Type	Contract	Description
StartUtc	string	required	Start of the interval in UTC timezone in ISO 8601 format (see Datetimes).
EndUtc	string	required	End of the interval in UTC timezone in ISO 8601 format (see Datetimes).

Date interval

{
    "Start": "2025-09-01",
    "End": "2025-09-15"
}

Property	Type	Contract	Description
Start	string	required	Starting date of the interval in ISO 8601 format.
End	string	required	Ending date of the interval in ISO 8601 format.

String update value

{
    "Value": "182a56ee-037d-4da5-b6f8-ada8006e7d5c"
}

Property	Type	Contract	Description
Value	string	optional	Value which is to be updated.

Bool update value

{
    "Value": false
}

Property	Type	Contract	Description
Value	boolean	optional	Value which is to be updated.

Number update value

{
    "Value": 6
}

Property	Type	Contract	Description
Value	number	optional	Value which is to be updated.

Integer update value

{
    "Value": 5
}

Property	Type	Contract	Description
Value	integer	optional	Value which is to be updated.

Array of strings update value

{
    "Value": 
    [
        "182a56ee-037d-4da5-b6f8-ada8006e7d5c",
        "4a1a7f12-4024-41ba-9289-f90448682d3a"
    ]
}

Property	Type	Contract	Description
Value	array of strings	optional	Value which is to be updated.

Dictionary

Dictionary is a collection of key-value pairs, where both keys and values are strings.

{
    "TaxIdentifier": "CZ8810310963",
    "CityOfRegistration": "Prague"
}

Property	Type	Contract	Description
?Key?	string	optional	Some value corresponding to the ?Key? unique identifier. Cannot be null.

Dictionary of numbers

Dictionary of numbers is a collection of key-value pairs, where keys are strings and the values are numbers.

{
    "Amex": 0.05,
    "MasterCard": 9,
}

Dictionary of integer arrays

Dictionary of integer arrays is a collection of key-value pairs, where keys are strings and the values are arrays of integers.

{
    "OutOfOrderBlocks": [0, 1, 0, 0, 1],
    "PublicAvailabilityAdjustment": [7, 5, 4, 3, 4]
}

Property	Type	Contract	Description
?Key?	array of integer	optional	A set of integer values corresponding to the ?Key? unique identifier. Cannot be null.

Activity state

• Active - indicates active record.

• Deleted- indicates deleted record.

Localized text

A Dictionary object where the keys are Language codes and the corresponding values are versions of the text in the respective language. For example:

{
    "cs-CZ": "Děti",
    "da-DK": "Børn",
    "de-CH": "Kinder",
    "de-DE": "Kinder",
    "el-GR": "Παιδιά",
    "en-GB": "Children"
}

Profile data

Property	Type	Contract	Description
Discriminator	Profile data discriminator	required	Type of the profile data.
EnterpriseProfile	Enterprise profile data	optional	Enterprise profile data.

Profile data discriminator

• Personal

• Enterprise

• Platform

• Static

• Integration

Enterprise profile data

Property	Type	Contract	Description
ProfileId	string	required	Unique identifier of the profile.

Amount

Property	Type	Contract	Description
Currency	string	required	ISO-4217 code of the Currency.
NetValue	number	required	Net value without taxes.
GrossValue	number	required	Gross value including all taxes.
TaxValues	array of Tax value	required	The tax values applied.
Breakdown	Tax breakdown	required	Information about individual tax amounts.

Tax value

Property	Type	Contract	Description
Code	string	optional	Code corresponding to tax type.
Value	number	required	Amount of tax applied.

Tax breakdown

Property	Type	Contract	Description
Items	array of Tax breakdown item	required	Tax breakdown items per each tax rate applied.

Tax breakdown item

Property	Type	Contract	Description
TaxRateCode	string	optional	Tax rate code for the item. null for untaxed amounts.
NetValue	number	required	The net value that the tax is calculated from.
TaxValue	number	required	The value of the tax.

Amount parameters

Property	Type	Contract	Description
GrossValue	decimal	optional	Amount including tax. Required for Gross Pricing environments.
NetValue	decimal	optional	Amount excluding tax. Required for Net Pricing environments.
Currency	string	required	ISO-4217 code of the Currency.
TaxCodes	array of string	required	Codes of Tax rates to be applied to the item. (Note, you can only define one tax when sending GrossValue. For multiple taxes, use NetValue)

Hybrid identifier

A hybrid identifier is a string with a specific format that allows the use of alternative unique identifiers, in addition to the entity's unique identifier. When using these alternative identifiers, a corresponding prefix must be included as part of the value.

Identifier	Prefix	Value example	Description
Primary identifier	(no prefix)	a01bc7c3-cfa2-4ad6-a360-5cb8b4004ab5	Primary identifier of the entity e.g. Id field on Service.
External identifier	eid:	eid:COM-123	External identifier of the entity e.g. ExternalIdentifier field on Service.

Currency value (ver 2018-06-07)

Usage of this value is deprecated. Where possible, use the properties exposing the Amount instead.

Property	Type	Contract	Description
Currency	string	required	ISO-4217 code of the Currency.
Value	number	optional	Amount in the currency.
Net	number	optional	Deprecated!
Tax	number	optional	Deprecated!
TaxRate	number	optional	Deprecated!

Currency value (ver 2023-02-02)

Property	Type	Contract	Description
Currency	string	required
Value	number	required

Activity state

• Deleted

• Active