API - Items
This is a fork of page 30008 "APIV2 - Items" from version 23.3.14876.15704. Added support for Extra Fields and Extra Values.
Object Definition
| Object Type | Page |
| Object ID | 70314146 |
| Object Name | QWESR API - Items |
| Source Table | Item |
API Definition
| APIPublisher | smartApps |
| APIGroup | spider |
| APIVersion | v1.0 |
| EntitySetName | items |
| EntityName | item |
Events
| Name | Description |
|---|---|
| OnAfterInsert(Record Item; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer]) | Raised after a record is inserted. A Modify of the Item record will be called after this event. |
| OnBeforeModify(Record Item; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer]) | Raised before a record is modified. |
| OnGetExtraValues(Record Item; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text) | Raised after a record is read from the database. Makes it possible to set the ExtraValues 1..10, to be returned to the client. |
Example
Read
Get a list of Items.
GET businesscentralPrefix/companies({id})/items?$schemaversion=2.0
Get a single Item and it's base unit of measure.
GET businesscentralPrefix/companies({id})/items({id})?$expand=unitsOfMeasure&$schemaversion=2.0
Create
Create a new Item.
POST businesscentralPrefix/companies({id})/items?$schemaversion=2.0
Content-type: application/json
{
"displayName": "Bicycle"
}
Controls
| Type | Name | Data Type | Read-only |
|---|---|---|---|
| Field | id | Guid | Yes |
| Field | number | Code[20] | |
| Field | displayName | Text[100] | |
| Field | displayName2 | Text[50] | |
| Field | type | Enum "Item Type" | |
| Field | itemCategoryId | Guid | |
| Field | itemCategoryCode | Code[20] | |
| Field | blocked | Boolean | |
| Field | gtin | Code[14] | |
| Field | inventory | Decimal | |
| Field | unitPrice | Decimal | |
| Field | priceIncludesTax | Boolean | |
| Field | unitCost | Decimal | |
| Field | taxGroupId | Guid | |
| Field | taxGroupCode | Code[20] | |
| Field | baseUnitOfMeasureId | Guid | |
| Field | baseUnitOfMeasureCode | Code[10] | |
| Field | generalProductPostingGroupId | Guid | |
| Field | generalProductPostingGroupCode | Code[20] | |
| Field | inventoryPostingGroupId | Guid | |
| Field | inventoryPostingGroupCode | Code[20] | |
| Field | lastModifiedDateTime | DateTime | Yes |
| Field | extraCode1 | Code[20] | |
| Field | extraCode2 | Code[20] | |
| Field | extraCode3 | Code[20] | |
| Field | extraCode4 | Code[20] | |
| Field | extraCode5 | Code[20] | |
| Field | extraCode6 | Code[20] | |
| Field | extraCode7 | Code[20] | |
| Field | extraCode8 | Code[20] | |
| Field | extraText1 | Text[50] | |
| Field | extraText2 | Text[50] | |
| Field | extraText3 | Text[50] | |
| Field | extraText4 | Text[50] | |
| Field | extraDecimal1 | Decimal | |
| Field | extraDecimal2 | Decimal | |
| Field | extraDecimal3 | Decimal | |
| Field | extraDecimal4 | Decimal | |
| Field | extraInteger1 | Integer | |
| Field | extraInteger2 | Integer | |
| Field | extraInteger3 | Integer | |
| Field | extraInteger4 | Integer | |
| Field | extraDate1 | Date | |
| Field | extraDate2 | Date | |
| Field | extraDate3 | Date | |
| Field | extraDate4 | Date | |
| Field | extraBoolean1 | Boolean | |
| Field | extraBoolean2 | Boolean | |
| Field | extraBoolean3 | Boolean | |
| Field | extraBoolean4 | Boolean | |
| Field | extraValue1 | Text | |
| Field | extraValue2 | Text | |
| Field | extraValue3 | Text | |
| Field | extraValue4 | Text | |
| Field | extraValue5 | Text | |
| Field | extraValue6 | Text | |
| Field | extraValue7 | Text | |
| Field | extraValue8 | Text | |
| Field | extraValue9 | Text | |
| Field | extraValue10 | Text | |
| Sub page | inventoryPostingGroup | Yes | |
| Sub page | generalProductPostingGroup | Yes | |
| Sub page | baseUnitOfMeasure | ||
| Sub page | picture | ||
| Sub page | defaultDimensions | ||
| Sub page | itemVariants | ||
| Sub page | documentAttachments |
This documentation is generated from Spider v27.0