Get stock report

GET /api-v1/stock-report

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Query parameters

direction string

Sorting direction

Values are ASC or DESC. Default value is ASC.
pageNumber integer(int32)

Page Number

Default value is 1.
sizePerPage integer(int32)

Size per page

Default value is 60.
sortingField string

Field to sort by

Responses

200

OK
Hide response attributes Show response attributes object
- articleId integer
- articleIdToDisplay string
- articleName object
  
  Additional properties are allowed.
  
  Hide articleName attributes Show articleName attributes object
  
  de string
  
  en string
  
  fr string
  
  it string
- categoryId number
- date string(date-time)
- departmentId number
- inQuantity number
- measurement string
  
  Values are UNIT, ML, DL, L, HL, G, KG, T, H, M, M_2, M_3, KM, or DAY.
- officeId integer
- organizationId integer
- outQuantity number
- quantityProjection number
- totalCost number
- totalQuantity number
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/stock-report

curl \
 -X GET http://10.10.10.132/api-v1/stock-report \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "articleId": 42,
    "articleIdToDisplay": "string",
    "articleName": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "it": "string"
    },
    "categoryId": 42.0,
    "date": "2024-05-04T09:42:00+00:00",
    "departmentId": 42.0,
    "inQuantity": 42.0,
    "measurement": "UNIT",
    "officeId": 42,
    "organizationId": 42,
    "outQuantity": 42.0,
    "quantityProjection": 42.0,
    "totalCost": 42.0,
    "totalQuantity": 42.0
  }
]