/Documents/{documentKey}/Positions
Description
Reads the items of the specified voucher. The document type and the document number are required for this.
Request
URI Parameters
documentKey
string
Required
DocumentStatus
string
Document status
Page
integer
Page number for paging | Default: 0
Items
integer
Sets the number of entries per page | Default: 10 | All: 0
SearchTerm
string
Filter for words
SearchIn
string
Properties in which to search. The separator between these properties is "|".
OrderBy
string
Properties to be sorted by. An exclamation mark ! at the end indicates downward sorting. To sort by several properties, they must be separated by a "|".
Filter
string
A filter can be defined to limit the result set. For example: (Property EQ Value OR Property2 GT Value2) AND (Property3 CT 'String') See the description for the FilterQueryLanguage for more information.
withDetails
boolean
Default value is: False
withEmployeeLabel
boolean
Default value is: False
withLocationLabel
boolean
Default value is: False
withProjectLabel
boolean
Default value is: False
withRejectArticleLabel
boolean
Default value is: False
withStoragePlaceLabel
boolean
Default value is: False
withTaxCode
boolean
Default value is: False
withWarehouseLabel
boolean
Default value is: False
Body Parameters
None.
Response
Resource Description
PositionKind
string
Length: including between 0 and 1
Read only
Indicates the type of item. A - Item | B - Invoice back in final invoice | E - Shipping | F - Document mark-up | G - Sub-item | H - Trade bill of material | K - Comment | N - Partial invoice total in final invoice | P - Project total in final invoice | Q - Partial invoice item in final invoice | R - Invoice back in final invoice | S - Outline total | T - Partial total | W - Page break | Z - Subtotal [DOCUMENTP].[LineType].
PositionNumberText
string
Length: including between 0 and 15
Specifies the position within the line items as text. [DOCUMENTP].[Postext]
MetaData
Read only
Clients for the data rate
Identifier
globally unique identifier
Read only
Specifies the identifier for the position. [DOCUMENTP].[Identifier]
PredecessorIdentifier
globally unique identifier
Read only
Indicates the identifier of the predecessor position. [DOCUMENTP].[Predecessor].
ParentIdentifier
globally unique identifier
Read only
Indicates the main identifier of the position. [DOCUMENTP].[MainIdentifier].
ProductionIdentifier
globally unique identifier
Read only
Indicates the manufacturing identifier. [DOCUMENTP].[Manufacturing]
DocumentKind
string
Length: including between 0 and 1
Read only
Indicates the type for the document. A - Customer offer | B - Purchase order | E - Incoming invoice | F - Order | G - Credit note | I - Stocktaking | L - Delivery note | N - Inquiry | P - Packing slip | R - Invoice | S - Goods receipt | T - Partial invoice | U - Advance payment | Z - Interested party offer [DOCUMENTP].[DocumentType].
DocumentNumber
string
Length: including between 0 and 10
Read only
Specifies the number for the associated document. [DOCUMENTP].[DocumentNumber]
PositionNumber
integer
Read only
Specifies the position within the line items. [DOCUMENTP].[ItemNumber]
RevenueKind
string
Length: including between 0 and 1
Read only
Indicates the type for turnover. A = Outgoing turnover | E = Incoming turnover [DOCUMENTP].[Turnover].
Date
date
Read only
Specifies the delivery date for the document. [DOCUMENTP].[Date]
StatusFlag
string
Read only
Indicates the current status for the item. 0 - open | 1 - partial | 2 - accepted | 3 - manually completed | 4 - cancelled in the cash voucher [DOCUMENTP].[Status].
LocationLabel
string
Read only
Give the designation for the location of stock.
StoragePlaceLabel
string
Read only
Give the designation for the stock location.
StoragePlace
string
Read only
Outputs the storage location dimension coordinates. Example: 1,3,2 in a three-dimensional storage.
SerialOrChargeFlag
string
Read only
Indicates whether this is a serial number, batch number or neither. O - Without | S - Serial number | C - Batch number | V - Serial number in sale [DOCUMENTP].[SerieCharge].
SerialOrChargeLabel
string
Read only
Gibt die Bezeichnung für das Serien- oder Chargeflag an.
QuantityTransferredFromDocumentPredecessor
decimal number
Read only
Indicates the quantity that was taken over from the preceding document. [DOCUMENTP].[Transfer].
QuantityTakenOverByDocumentSuccessor
decimal number
Read only
Indicates the quantity that was taken over from the preceding document. [DOCUMENTP].[Transfer].
OutstandingAbsorptionAmount
decimal number
Read only
Indicates the total of items not yet taken over in the currency of the document. [DOCUMENTP].[TakeOverOpen]
ReferenceAddressNumber
string
Length: including between 0 and 13
Read only
Indicates the reference number of the trader. [DOCUMENTP].[AddressNo]
ActualQuantity
decimal number
Read only
Indicates the actual consumption of a production BOM item in the work order. [DOCUMENTP].[ActualQuantity].
Quantity
decimal number
Read only
Specifies the quantity. [DOCUMENTP].[Quantity]
ArticleKindFlag
string
Length: including between 0 and 1
Read only
Indicates the abbreviation for the type of item. K - none | H - trade | P - production | D - sample type II | Z - surcharge item | F - document surcharge [DOCUMENTP].[BillOfMaterial].
ArticleKindLabel
string
Read only
Gibt die Bezeichnung für die Art des Artikels an.
PlanningKindLabel
string
Read only
Gibt die Bezeichnung für die Dispositionsart an.
DoExplodeSetArticle
boolean
Read only
Specifies whether the BOM is to be exploded. [DOCUMENTP].[BOMResolve]
RejectArticleNumber
string
Length: including between 0 and 18
Read only
Indicates the scrap item number. [DOCUMENTP].[Scrap item number].
RejectArticleLabel
string
Read only
Specifies the name of the reject item.
SurchargeRefersToArticleIdentifier
globally unique identifier
Read only
Indicates the identifier of the item to which the surcharge applies. [DOCUMENTP].[SurchargeFor].
CalculationPriceInEuro
decimal number
Read only
Indicates the calculation price in EUR. [BELEGP].[CalculationPriceEuro].
CalculationPriceInObsoleteCurrency
decimal number
Read only
Indicates the calculation price in the national currency before EUR. [DOCUMENTP].[CalcPriceOld].
NetAmount
decimal number
Read only
Specifies the net amount in the document currency. [DOCUMENTP].[Net]
NetAmountInEuro
decimal number
Read only
Indicates the net amount in EUR. [DOCUMENTP].[Net Euro]
NetAmountInObsoleteCurrency
decimal number
Read only
Indicates the net amount in the national currency before EUR. [DOCUMENTP]. [NetOld].
NetAmountLessDiscount
decimal number
Read only
Specifies the net amount after the discount in the document currency. [DOCUMENTP].[RNet]
NetAmountLessDiscountInEuro
decimal number
Read only
Indicates the net amount after the discount in EUR. [DOCUMENTP].[RNetEuro]
NetAmountLessDiscountInObsoleteCurrency
decimal number
Read only
Indicates the net amount after the discount in the national currency before EUR. [DOCUMENTP].[RNetOld]
CashOrBranchOfficeNumber
integer
Read only
Specifies the number for the cash register or branch. [DOCUMENTP].[CheckoutBranchNo].
IsSalesTaxIdNecessary
boolean
Read only
Indicates whether the VAT ID is required. [DOCUMENTP].[VATIDRequired]
PlanningKindFlag
string
Length: including between 0 and 1
Read only
Indicates the disposition type. K - None | B - Stock | A - Order | G - Demand-driven [DOCUMENTP].[DispositionType].
ExtraFieldsWithType
Collection of ExtraFieldWithType
Read only
The extra fields of the document with the information on the data type.
LocationId
string
Length: including between 0 and 10
Specifies the number for the location of the warehouse. [DOCUMENTP].[Location] = LOCATIONW
InputQuantityValue
string
Length: including between 0 and 20
Specifies the quantity that is entered via the input mask of the WAWI. This can also be a calculation formula. [DOCUMENTP].[EditQuantity].
StorageFactor
decimal number
Indicates the storage factor for calculating the actual quantity. [DOCUMENTP].[StorageFactor]
PriceOptions
integer
Indicates whether the price is transferred to the delivery condition. 0 - price is taken over. 1 - price is not taken over. [DOCUMENTP].[PriceOptions]
ReferenceNumber
string
Length: including between 0 and 30
Specifies the reference or EAN number. [DOCUMENTP].[Reference]
PriceQuantity
decimal number
Indicates the price quantity. [DOCUMENTP].[PriceQuantity]
IsInventorySelection
boolean
Indicates whether stock removals should take place before the line item is closed. [DOCUMENTP].[StockSelection]
Details
Additional information to be called up for the document items (exclusively for the normal document chain)
StoragePlaceId
integer
Indicates the number for the storage bin. [DOCUMENTP].[StorageBinID] = STORAGE BIN
DeliveryDate
date
Indicates the delivery date of the item. [DOCUMENTP].[Date]
WarehouseId
string
Length: including between 0 and 10
Indicates the number for the bearing. [DOCUEMTNP].[STORAGE] = STORAGE
WarehouseLabel
string
Read only
Give the designation for the stock.
EmployeeNumber
string
Length: including between 0 and 6
Specifies the number for the representative / employee. [DOCUMENTP].[Employee] = EMPLOYEEBW
EmployeeLabel
string
Read only
Give designation for the representative/employee.
IsPrintLock
boolean
Indicates whether a print lock is active. [DOCUMENTP].[PrintLock]
Commission
decimal number
Specifies the percentage value for the commission. [DOCUMENTP].[Commission]
BusinessPartnerReferenceAddressNumber
string
Length: including between 0 and 13
Specifies the reference number for the customer, supplier or prospect. [DOCUMENTP].[RefAddress]
CalculatedQuantityValue
decimal number
Specifies the quantity calculated in real terms from the quantity or formula entered via the input mask of the WAWI. [DOCUMENTP].[InputQuantity].
CalculationPrice
decimal number
Indicates the costing price in the document currency. [DOCUMENTP].[CalculationPrice].
AccessoryOrSurchargeFlag
string
Length: including between 0 and 1
Indicates the accessory / surcharge type. B - Accessory | Z - Surcharge Item | L - Power [DOCUMENTP].[PosType]
ArticleNumber
string
Length: including between 0 and 18
Indicates the item number. [DOCUMENTP].[ItemNumber]
GoodsNumber
string
Length: including between 0 and 8
Indicates the commodity code. [DOCUMENTP].[CommodityCode]
OrderNumber
string
Length: including between 0 and 40
Indicates the order number. [DOCUMENTP].[OrderNumber]
Name
string
Length: including between 0 and 80
Specifies the designation. [DOCUMENTP].[Name]
AdditionalDescription
string
Length: including between 0 and 80
Gibt eine zusätzliche Beschreibung an. [BELEGP].[Zusatz]
QuantityUnit
string
Length: including between 0 and 10
Specifies the unit of measure. [DOCUMENTP].[UnitOfMeasure]
Weight
decimal number
Indicates the weight. [DOCUMENTP].[Weight]
IsWarehouseArticle
boolean
Indicates whether the item is a stock item. [DOCUMENTP].[StorageItem]
IsCommissionArticle
boolean
Indicates whether the item is commissionable. [DOCUEMTNP].[CommissionItem].
PriceQuantityUnit
string
Length: including between 0 and 10
Specifies the price unit. [DOCUMENTP].[PriceUnit].
PriceUnitFactor
decimal number
Indicates the price unit. [DOCUMENTP].[PriceUnit]
UnitPrice
decimal number
Indicates the unit price. [DOCUMENTP].[UnitPrice]
DiscountPercent
decimal number
Specifies the discount. [DOCUMENTP].[Discount]
DiscountPercent2
decimal number
Specifies the discount2. [DOCUMENTP].[Discount2]
TotalPrice
decimal number
Indicates the total price. [DOCUMENTP].[TotalPrice]
CostCentreName
string
Length: including between 0 and 15
Specifies the name for the cost centre. [DOCUMENTP].[CostCentre]
PayerName
string
Length: including between 0 and 15
Indicates the name for the cost unit. [DOCUMENTP].[CostUnit]
TaxCode
string
Length: including between 0 and 2
Specifies the tax code. [DOCUMENTP].[TaxCode] = USTSCHL
TaxCodeLabel
string
Read only
Give designation for the tax code.
TaxRate
decimal number
Indicates the tax rate in percent. [DOCUMENTP].[TaxPercent]
FinancialAccountId
string
Length: including between 0 and 15
Specifies the abbreviation for the financial account. [DOCUMENTP].[Account]
IsDiscountAllowed
boolean
Indicates whether the item is eligible for a discount. [DOCUMENTP].[Discountable].
IsCashDiscountAllowed
boolean
Indicates whether the item is eligible for a cash discount. [DOCUMENTP].[Cash Discount Allowed]
CustomText1
string
Length: including between 0 and 80
Free Text 1 [DOCUMENTP].[Free1]
CustomText2
string
Length: including between 0 and 80
Free text 2 [DOCUMENTP].[Free2]
CustomDate
date
Free date [DOCUMENTP].[FreeDate].
CustomNumber
decimal number
Free number [DOCUMENTP].[FreeNumber].
Memo
string
Indicates the memo description/comment.
OSSProcedure
Indicates the one-stop shop procedure. This can only be customised in outgoing documents.
ProjectId
integer
Specifies the number for the project. [DOCUMENTP].[Project] = WPROJECT
ProjectLabel
string
Read only
Give the designation for the project.
Response Formats
application/json
Example:
[
{
"PositionKind": "sample string 1",
"PositionNumberText": "sample string 2",
"MetaData": {
"CreationDate": "2024-12-26T21:30:58.4747789+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-12-26T21:30:58.4747789+01:00",
"ModificationUserToken": "sample string 2"
},
"Identifier": "f866b634-6d82-4e6f-a1df-8aa0e65e543d",
"PredecessorIdentifier": "e0e45853-3a27-4965-85f6-197dfee90d56",
"ParentIdentifier": "6a95b314-aa4e-4b97-b5d8-7d5aeda03e0d",
"ProductionIdentifier": "abd5c135-0a80-4d82-a1fb-e0b0d6cc0d0c",
"DocumentKind": "sample string 5",
"DocumentNumber": "sample string 6",
"PositionNumber": 7,
"RevenueKind": "sample string 8",
"Date": "2024-12-26T21:30:58.4747789+01:00",
"StatusFlag": "sample string 9",
"LocationLabel": "sample string 10",
"StoragePlaceLabel": "sample string 11",
"StoragePlace": "sample string 12",
"SerialOrChargeFlag": "sample string 13",
"SerialOrChargeLabel": "sample string 14",
"QuantityTransferredFromDocumentPredecessor": 15.1,
"QuantityTakenOverByDocumentSuccessor": 16.1,
"OutstandingAbsorptionAmount": 17.1,
"ReferenceAddressNumber": "sample string 18",
"ActualQuantity": 19.1,
"Quantity": 20.1,
"ArticleKindFlag": "sample string 21",
"ArticleKindLabel": "sample string 22",
"PlanningKindLabel": "sample string 23",
"DoExplodeSetArticle": true,
"RejectArticleNumber": "sample string 25",
"RejectArticleLabel": "sample string 26",
"SurchargeRefersToArticleIdentifier": "aa9aec5d-b427-4828-a4be-3515555399e3",
"CalculationPriceInEuro": 27.1,
"CalculationPriceInObsoleteCurrency": 28.1,
"NetAmount": 29.1,
"NetAmountInEuro": 30.1,
"NetAmountInObsoleteCurrency": 31.1,
"NetAmountLessDiscount": 32.1,
"NetAmountLessDiscountInEuro": 33.1,
"NetAmountLessDiscountInObsoleteCurrency": 34.1,
"CashOrBranchOfficeNumber": 35,
"IsSalesTaxIdNecessary": true,
"PlanningKindFlag": "sample string 37",
"ExtraFieldsWithType": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"Type": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"Type": "sample string 3"
}
],
"LocationId": "sample string 38",
"InputQuantityValue": "sample string 39",
"StorageFactor": 40.1,
"PriceOptions": 41,
"ReferenceNumber": "sample string 42",
"PriceQuantity": 43.1,
"IsInventorySelection": true,
"Details": {
"RecordId": 1,
"PositionIdentifier": "a6c0a21c-5582-4c7d-bae0-905a8a344a33",
"PriceGroupNumberOfAccessory": "sample string 3",
"QuantityUnitOfAccessory": "sample string 4",
"QuantityFormulaOfAccessory": "sample string 5",
"UpdateQuantityOfAccessory": true
},
"StoragePlaceId": 45,
"DeliveryDate": "2024-12-26T21:30:58.4747789+01:00",
"WarehouseId": "sample string 46",
"WarehouseLabel": "sample string 47",
"EmployeeNumber": "sample string 48",
"EmployeeLabel": "sample string 49",
"IsPrintLock": true,
"Commission": 51.1,
"BusinessPartnerReferenceAddressNumber": "sample string 52",
"CalculatedQuantityValue": 53.1,
"CalculationPrice": 54.1,
"AccessoryOrSurchargeFlag": "sample string 55",
"ArticleNumber": "sample string 56",
"GoodsNumber": "sample string 57",
"OrderNumber": "sample string 58",
"Name": "sample string 59",
"AdditionalDescription": "sample string 60",
"QuantityUnit": "sample string 61",
"Weight": 62.1,
"IsWarehouseArticle": true,
"IsCommissionArticle": true,
"PriceQuantityUnit": "sample string 65",
"PriceUnitFactor": 66.1,
"UnitPrice": 67.1,
"DiscountPercent": 68.1,
"DiscountPercent2": 69.1,
"TotalPrice": 70.1,
"CostCentreName": "sample string 71",
"PayerName": "sample string 72",
"TaxCode": "sample string 73",
"TaxCodeLabel": "sample string 74",
"TaxRate": 75.1,
"FinancialAccountId": "sample string 76",
"IsDiscountAllowed": true,
"IsCashDiscountAllowed": true,
"CustomText1": "sample string 79",
"CustomText2": "sample string 80",
"CustomDate": "2024-12-26T21:30:58.4747789+01:00",
"CustomNumber": 1.1,
"Memo": "sample string 81",
"OSSProcedure": {
"Value": 1,
"Name": "NoParticipation"
},
"ProjectId": 82,
"ProjectLabel": "sample string 83"
},
{
"PositionKind": "sample string 1",
"PositionNumberText": "sample string 2",
"MetaData": {
"CreationDate": "2024-12-26T21:30:58.4747789+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-12-26T21:30:58.4747789+01:00",
"ModificationUserToken": "sample string 2"
},
"Identifier": "f866b634-6d82-4e6f-a1df-8aa0e65e543d",
"PredecessorIdentifier": "e0e45853-3a27-4965-85f6-197dfee90d56",
"ParentIdentifier": "6a95b314-aa4e-4b97-b5d8-7d5aeda03e0d",
"ProductionIdentifier": "abd5c135-0a80-4d82-a1fb-e0b0d6cc0d0c",
"DocumentKind": "sample string 5",
"DocumentNumber": "sample string 6",
"PositionNumber": 7,
"RevenueKind": "sample string 8",
"Date": "2024-12-26T21:30:58.4747789+01:00",
"StatusFlag": "sample string 9",
"LocationLabel": "sample string 10",
"StoragePlaceLabel": "sample string 11",
"StoragePlace": "sample string 12",
"SerialOrChargeFlag": "sample string 13",
"SerialOrChargeLabel": "sample string 14",
"QuantityTransferredFromDocumentPredecessor": 15.1,
"QuantityTakenOverByDocumentSuccessor": 16.1,
"OutstandingAbsorptionAmount": 17.1,
"ReferenceAddressNumber": "sample string 18",
"ActualQuantity": 19.1,
"Quantity": 20.1,
"ArticleKindFlag": "sample string 21",
"ArticleKindLabel": "sample string 22",
"PlanningKindLabel": "sample string 23",
"DoExplodeSetArticle": true,
"RejectArticleNumber": "sample string 25",
"RejectArticleLabel": "sample string 26",
"SurchargeRefersToArticleIdentifier": "aa9aec5d-b427-4828-a4be-3515555399e3",
"CalculationPriceInEuro": 27.1,
"CalculationPriceInObsoleteCurrency": 28.1,
"NetAmount": 29.1,
"NetAmountInEuro": 30.1,
"NetAmountInObsoleteCurrency": 31.1,
"NetAmountLessDiscount": 32.1,
"NetAmountLessDiscountInEuro": 33.1,
"NetAmountLessDiscountInObsoleteCurrency": 34.1,
"CashOrBranchOfficeNumber": 35,
"IsSalesTaxIdNecessary": true,
"PlanningKindFlag": "sample string 37",
"ExtraFieldsWithType": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"Type": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"Type": "sample string 3"
}
],
"LocationId": "sample string 38",
"InputQuantityValue": "sample string 39",
"StorageFactor": 40.1,
"PriceOptions": 41,
"ReferenceNumber": "sample string 42",
"PriceQuantity": 43.1,
"IsInventorySelection": true,
"Details": {
"RecordId": 1,
"PositionIdentifier": "a6c0a21c-5582-4c7d-bae0-905a8a344a33",
"PriceGroupNumberOfAccessory": "sample string 3",
"QuantityUnitOfAccessory": "sample string 4",
"QuantityFormulaOfAccessory": "sample string 5",
"UpdateQuantityOfAccessory": true
},
"StoragePlaceId": 45,
"DeliveryDate": "2024-12-26T21:30:58.4747789+01:00",
"WarehouseId": "sample string 46",
"WarehouseLabel": "sample string 47",
"EmployeeNumber": "sample string 48",
"EmployeeLabel": "sample string 49",
"IsPrintLock": true,
"Commission": 51.1,
"BusinessPartnerReferenceAddressNumber": "sample string 52",
"CalculatedQuantityValue": 53.1,
"CalculationPrice": 54.1,
"AccessoryOrSurchargeFlag": "sample string 55",
"ArticleNumber": "sample string 56",
"GoodsNumber": "sample string 57",
"OrderNumber": "sample string 58",
"Name": "sample string 59",
"AdditionalDescription": "sample string 60",
"QuantityUnit": "sample string 61",
"Weight": 62.1,
"IsWarehouseArticle": true,
"IsCommissionArticle": true,
"PriceQuantityUnit": "sample string 65",
"PriceUnitFactor": 66.1,
"UnitPrice": 67.1,
"DiscountPercent": 68.1,
"DiscountPercent2": 69.1,
"TotalPrice": 70.1,
"CostCentreName": "sample string 71",
"PayerName": "sample string 72",
"TaxCode": "sample string 73",
"TaxCodeLabel": "sample string 74",
"TaxRate": 75.1,
"FinancialAccountId": "sample string 76",
"IsDiscountAllowed": true,
"IsCashDiscountAllowed": true,
"CustomText1": "sample string 79",
"CustomText2": "sample string 80",
"CustomDate": "2024-12-26T21:30:58.4747789+01:00",
"CustomNumber": 1.1,
"Memo": "sample string 81",
"OSSProcedure": {
"Value": 1,
"Name": "NoParticipation"
},
"ProjectId": 82,
"ProjectLabel": "sample string 83"
}
]