Skip to content

Article_GetAll

GET
/v1/articles
curl --request GET \
  --url https://rms.dev.caspeco.net/api/booking/v1/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'system: example'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
system
required
string

The system name / database to query

Query Parameters

Section titled “Query Parameters”
id
Array<integer>
nullable
centralArticleType
string
nullable
includeAccountInfo
boolean
includeImageData
boolean

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>
object
id
integer format: int64
name
string
nullable
articleGroupId
integer format: int64
sortOrder
integer format: int32
departmentIds
Array<integer>
nullable
description
string
nullable
price
number format: decimal
inPrice
number format: decimal
useCalculatedInPrice
boolean
priceIsIncludingVat
boolean
vatPercent
number format: decimal
articleNumber
string
nullable
supplierArticleNumber
string
nullable
supplierId
integer format: int64
subArticles
Array<object>
nullable
object
id
integer format: int64
subArticleId
integer format: int64
parentArticleId
integer format: int64
quantity
number format: double
quantityAsString
string
nullable
overridePrice
number format: double
discount
number format: double
offsetMinutes
integer format: int32
information
string
nullable
parentArticles
Array<object>
nullable
object
id
integer format: int64
subArticleId
integer format: int64
parentArticleId
integer format: int64
quantity
number format: double
quantityAsString
string
nullable
overridePrice
number format: double
discount
number format: double
offsetMinutes
integer format: int32
information
string
nullable
unit
string
nullable
receiptText
string
nullable
keepStockBalance
boolean
hidden
boolean
articleGroupHidden
boolean
furnishingIds
Array<integer>
nullable
canChangeTax
boolean
isContainer
boolean
canChangePrice
boolean
priceModel
integer
Allowed values: 0 1
roundUpTo
integer
Allowed values: 1 15 30 60 120 240
isDayBreak
boolean
inactivatedUntil
string format: date-time
changeDate
string format: date-time
nullable
articleGroupChangeDate
string format: date-time
nullable
dayBreakTime
string
nullable
preparationTime
integer format: int32
restorationTime
integer format: int32
stockBalance
integer format: int32
stockType
integer
Allowed values: 0 1 2 3
includedInResourcePool
boolean
isRentalArticle
boolean
deliverOnStartTime
boolean
showPrinting
boolean
specialFood
boolean
copyInformation
boolean
isSubInvoice
boolean
webFlags
integer
Allowed values: 0 1 2 3
isPackage
integer
Allowed values: 0 1 2
nonDiscountable
boolean
nullable
centralKey
string
nullable
binaryFlags
integer
Allowed values: 0 1 2 8
image
string
nullable
imageUrl
string
nullable
imageFilename
string
nullable
imageUploadData
string
nullable
tableInfos
Array<object>
nullable
object
tableId
integer format: int64
templateId
integer format: int64
unitId
integer format: int64
templateName
string
nullable
tableName
string
nullable
articleId
integer format: int64
sectionId
integer format: int64
accounting
One of:
object
account
string
nullable
vatAccount
string
nullable
costOfGoodsAccount
string
nullable
costCenter
string
nullable
Example
[
  {
    "priceModel": 0,
    "roundUpTo": 1,
    "stockType": 0,
    "webFlags": 0,
    "isPackage": 0,
    "binaryFlags": 0
  }
]