API Entities

product

means the property is read-only.

Property Type Explanation
productNumber bigint
syncMarker bigint
description string
extraText string
articleList List of article
groupNumbers int[]
sortOrderGroupList List of SortOrderGroupList

article

means the property is read-only.

Property Type Explanation
articleNumber bigint
extArticleId string
pluNumber string
syncMarker bigint
changeTimestamp SoapMplusDateTime
createTimestamp SoapMplusDateTime
active boolean
description string
colour string
size string
invoiceText string
receiptText string
displayText string
barcode string
brandName string
extraText string
turnoverGroup int
vatCode int
vatPercentage int
purchasePrice int
priceIncl int
priceExcl int
siUnit string
unit string
orderQuantityValue bigint
orderQuantityDecimalPlaces int
supplierRelationNumber bigint
supplierRelationName string
supplierArticleNumber string
webshop boolean
categoryId int
stockArticle boolean
imageList List of image
customFieldList List of customField
salesPriceList List of salesPrice
priceGroupList List of priceGroup
preparationMethodList List of preparationMethod
componentArticleList List of componentArticle
allergenList List of allergen
linkedArticle List of linkedArticle

relation

means the property is read-only.

Property Type Explanation
relationNumber bigint
extRelationId string
syncMarker bigint
createTimestamp SoapMplusDateTime
changeTimestamp SoapMplusDateTime
active boolean
name string
address string
zipcode string
city string
country string
deliveryAddress string
deliveryZipcode string
deliveryCity string
deliveryCountry string
contact string
telephone string
mobile string
email string
website string
birthDate SoapMplusDate
relationCode string
points int
balance int
priceGroupNumber int
discountPercentage int
categoryId int
cardNumber string
bankAccountNumber string
creditLimit bigint
paymentWithinDays int
vatNumber string
commerceNumber string
extraText string
defaultVatMethod VatMethod
neverPrintOrEmailReceipt boolean
alwaysPrintReceipt boolean
alwaysPrintLargeFormatReceipt boolean
alwaysEmailReceipt boolean
condenseCombinedInvoice boolean
imageList List of image
customFieldList List of customField

order

means the property is read-only.

Property Type Explanation
orderId uuid
extOrderId string
syncMarker bigint
orderType OrderType
entryBranchNumber int
entryExtBranchId string
employeeNumber bigint
employeeName string
entryTimestamp SoapMplusDateTime
relationNumber bigint
relationName string
deliveryAddress Address
invoiceAddress Address
financialDate SoapMplusDate
financialBranchNumber int
financialExtBranchId string
workplaceNumber int
reference string
totalInclAmount bigint
totalExclAmount bigint
vatMethod VatMethod
vatGroupList List of vatGroup
deliveryMethod string
deliveryDate SoapMplusDate
deliveryPeriodBegin SoapMplusDateTime
deliveryPeriodEnd SoapMplusDateTime
paymentMethod string
changeCounter int
versionNumber int
prepaidAmount bigint
fullyPaid boolean
deliveryState OrderDeliveryState
cancelState OrderCancelState
completeState OrderCompleteState
tableNumber int
tableDescription string
numberOfGuests int
orderNumber YearNumber
orderCategoryNumber int
orderCategoryDescription string
lineList List of line
invoiceIds List of uuid
paymentList List of payment

image

means the property is read-only.

Property Type Explanation
imageId uuid
imageName string
imageHash string
imagePath string
imageUrl string
imageDate base64
imageDataResult LoadFileResult
thumbHash string
thumbPath string
thumbUrl string
thumbData base64
thumbDataResult LoadFileResult
imageWidth int
imageHeight int
thumbWidth int
thumbHeight int
createdTimestamp SoapMplusDateTime
changedTimestamp SoapMplusDateTime

customField

means the property is read-only.

Property Type Explanation
fieldName string
dataType DataType
isRequired boolean
strValue string
intValue bigint
decimalPlaces int
boolValue boolean
dateValue SoapMplusDate
dateTimeValue SoapMplusDateTime