Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
NEW VERSION This is v1.0 of the Business Central API. For the newest version, see Business Central API (V2.0).
Represents a dimension line in Business Central.
Note
For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.
Methods
| Method | Return Type | Description |
|---|---|---|
| GET dimensionLines | dimensionLines | Gets a dimension line object |
| POST dimensionLines | dimensionLines | Creates a dimension line object |
| PATCH dimensionLines | dimensionLines | Updates a dimension line object |
| DELETE dimensionLines | none | Deletes a dimension line object |
Properties
| Property | Type | Description |
|---|---|---|
| parentId | GUID | The ID of the parent entity. Non editable. |
| id | GUID | The unique ID of the dimension line. Non editable. |
| code | string, maximum size 20 | The code of the dimension. |
| displayName | string, maximum size 30 | The display name of the dimension. Read-Only. |
| valueId | GUID | The unique ID of the value of the dimension. |
| valueCode | string, maximum size 20 | The code of the value of the dimension. |
| valueDisplayName | string, maximum size 50 | The display name of the value of the dimension. Read-Only. |
Relationships
A dimension line must have a "Parent Entity" with an Id, that is represented by the parent Id. "Parent Entity" can be one of the following:
- Journal Line
- Customer Payment.
A Dimension (id) must exist in the Dimensions endpoint.
A Dimension Value (valueId) must exist in the Dimension Values endpoint.
JSON representation
Here is a JSON representation of the resource.
{
"parentId": "GUID",
"id": "GUID",
"code": "String",
"displayName": "String",
"valueId": "GUID",
"valueCode": "String",
"valueDisplayName": "String"
}
Related information
Get Dimension Line
Post Dimension Line
Patch Dimension Line
Delete Dimension Line