Skip to content

createArticlePresentation

Request

Bodyapplication/jsonrequired
idinteger, (int32)

Identifier of the object to modify or delete

Default:""
articleinteger, (int32)required

Article id

Default:""
Example:1
namestring, [ 0 .. 60 ] charactersrequired

Name of the presentation

Default:""
Example:"Caja"
multipliernumber, >= 0required

Number of units per pack (must be at least 1)

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)required

Document context where this presentation applies

Default:""
Enum:"PURCHASES""SALES""BOTH"
Example:"BOTH"
POST
/api/v1/article-presentation
curl -i -X POST \
  https://api.prana.software/api/v1/article-presentation \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "",
    "article": 1,
    "name": "Caja",
    "multiplier": 12,
    "active": true,
    "sortOrder": 0,
    "usageType": "PURCHASES"
  }'

Responses

OK

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
}