complex types JSON (v1.0)

NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).

These are the various complex types in Business Central. You can see usage of these complex types in the various individual methods that make use of them.

Note


For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Item category

Represents an Item Category complex type in Business Central.

Properties

PropertyTypeDescription
categoryIdstringThe unique ID of the item category.
descriptionstringSpecifies the description of the item category.
"ItemCategory"
{
  "categoryId": "string",
  "description": "string"
}

Unit of measure

Represents a Unit of Measure complex type in Business Central.

Properties

PropertyTypeDescription
codestringThe unique ID of the unit of measure.
displayNamestringSpecifies the description of the unit of measure.
symbolstringSpecifies a graphical representation of the unit of measure.
unitConversionSpecifies the conversion rate to a different (target) unit of measure.
"UnitOfMeasure"
{
  "code":  "string",
  "displayName": "string",
  "symbol": "string",
  "unitConversion": "NAV.ItemUnitOfMeasureConversion"
}

Unit of measure conversion

Represents a Unit of Measure Conversion complex type in Business Central.

Properties

PropertyTypeDescription
toUnitOfMeasurestringSpecifies the unit of measure to convert to.
fromToConversionRatedecimalSpecifies what the (source) base unit of measure is multiplied with in order to convert to the target unit of measure.
"ItemUnitOfMeasureConversion"
{
"toUnitOfMeasure": "string",
"fromToConversionRate": "decimal"
}

Payment method

Represents a Payment Method complex type in Business Central.

Properties

PropertyTypeDescription
codestringThe unique code of the payment method.
descriptionstringSpecifies a text that describes the payment method.
"PaymentMethod"
{
"code": "string",
"description": "string"
}

Payment terms

Represents a Payment Terms complex type in Business Central.

Properties

PropertyTypeDescription
codestringThe unique code of the payment terms.
descriptionstringSpecifies a text that describes the payment terms.
"PaymentTermsType"
{
"code": "string",
"description": "string"
}

Postal address

Represents a Postal Address complex type in Business Central.

Properties

PropertyTypeDescription
streetstringPostal address street.
citystringPostal address city.
statestringPostal address state.
countryLetterCodestringPostal address country letter code (two character word)
postalCodestringPostal address post code
"PostalAddress"
{
"street": "string",
"city": "string",
"state": "string",
"countryLetterCode": "string",
"postalCode": "string"
}

Shipment method

Represents a Shipment Method complex type in Business Central.

Properties

PropertyTypeDescription
codestringThe unique code of the shipment method.
descriptionstringSpecifies the description of the shipment method.
"ShipmentMethod"
{
"code": "string",
"description": "string"
}

Line details

Represents a Line Details complex type in Business Central.

Properties

PropertyTypeDescription
numberstringThe sequence number of the document line details.
displayNamestringThe display name of the line.
"documentLineObjectDetails"
{
"number": "string",
"displayName": "string"
}