patchArticlePresentation

Request

Path

idinteger, (int32)required

Bodyapplication/jsonrequired

property name*anyadditional property

PATCH

/api/v1/article-presentation/{id}

curl -i -X PATCH \
  'https://api.prana.software/api/v1/article-presentation/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "property1": null,
    "property2": null
  }'

Responses

Bodyapplication/json

idinteger, (int32)required

Unique identifier of the object

Default:""

namestring

Name of the presentation

Default:""

Example:"Caja"

multipliernumber

Number of units per pack

Default:""

Example:12

activeboolean

Whether the presentation is active

Default:false

Example:true

sortOrderinteger, (int32)

Display order of the presentation

Default:""

Example:0

usageTypestring(ApiArticlePresentationUsageEnum)

Document context where this presentation applies

Default:""

Enum:"PURCHASES""SALES""BOTH"

Example:"BOTH"

articleIdinteger, (int32)

ID of the article this presentation belongs to

Default:""

Example:1

Response

{
  "id": "",
  "name": "Caja",
  "multiplier": 12,
  "active": true,
  "sortOrder": 0,
  "usageType": "PURCHASES",
  "articleId": 1
}