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
Property | Type | Description |
---|---|---|
categoryId | string | The unique ID of the item category. |
description | string | Specifies 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
Property | Type | Description |
---|---|---|
code | string | The unique ID of the unit of measure. |
displayName | string | Specifies the description of the unit of measure. |
symbol | string | Specifies a graphical representation of the unit of measure. |
unitConversion | Specifies 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
Property | Type | Description |
---|---|---|
toUnitOfMeasure | string | Specifies the unit of measure to convert to. |
fromToConversionRate | decimal | Specifies 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
Property | Type | Description |
---|---|---|
code | string | The unique code of the payment method. |
description | string | Specifies a text that describes the payment method. |
"PaymentMethod"
{
"code": "string",
"description": "string"
}
Payment terms
Represents a Payment Terms complex type in Business Central.
Properties
Property | Type | Description |
---|---|---|
code | string | The unique code of the payment terms. |
description | string | Specifies a text that describes the payment terms. |
"PaymentTermsType"
{
"code": "string",
"description": "string"
}
Postal address
Represents a Postal Address complex type in Business Central.
Properties
Property | Type | Description |
---|---|---|
street | string | Postal address street. |
city | string | Postal address city. |
state | string | Postal address state. |
countryLetterCode | string | Postal address country letter code (two character word) |
postalCode | string | Postal 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
Property | Type | Description |
---|---|---|
code | string | The unique code of the shipment method. |
description | string | Specifies the description of the shipment method. |
"ShipmentMethod"
{
"code": "string",
"description": "string"
}
Line details
Represents a Line Details complex type in Business Central.
Properties
Property | Type | Description |
---|---|---|
number | string | The sequence number of the document line details. |
displayName | string | The display name of the line. |
"documentLineObjectDetails"
{
"number": "string",
"displayName": "string"
}