Skip to content

Prana API (1.0)

API Definition to interact with Prana platform

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://api.prana.software/

Stock Regularization

Manage your Stock Regularizations

Operations

Inventory

Manage your Inventories

Operations

Warehouse

Manage your Warehouses

Operations

Invoice

Manage your Invoices

Operations

Vat

Manage your vats

Operations

Bank

Manage your Banks

Operations

Country

Manage your countries

Operations

Quote

Manage your Quotes

Operations

Stock Transfer

Manage your Stock Transfers

Operations

Customer

Manage your Customers

Operations

Warehouse Movement

Manage your warehouse movements

Operations

Product

Manage your Products

Operations

Entry

Manage your entries

Operations

DeliveryNote

Manage your DeliveryNotes

Operations

Warehouse Accumulate

Manage your warehouse accumulates

Operations

Collection

Manage your Collections

Operations

Rate

Manage your rates

Operations

Supplier

Manage your Suppliers

Operations

Sale Price

Manage your Sale Prices

Operations

Purchase Invoice

Manage your Purchase Invoices

Operations

State

Manage your states

Operations

Payment Method

Manage your Payment Methods

Operations

Currency

Manage your Currencies

Operations

Recurring Billing Templates

Manage your recurring billing templates

Operations

Option

Manage your Options

Operations

Billing Series

Manage your Billing Series

Operations

Service

Manage your Services

Operations

Get Service

Request

Get a specific service.

Path
idinteger(int32)required
curl -i -X GET \
  'https://api.prana.software/api/v1/service/{id}'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestring[ 0 .. 20 ] charactersrequired

Code of the article

Example: "ART123"
descriptionstring[ 0 .. 100 ] characters

Description of the article

Example: "Premium leather jacket"
vatTypestring(ApiArticleVatTypeEnum)required
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "STANDARD"
heightnumber

Height of the article

Example: 10.5
widthnumber

Width of the article

Example: 20.3
depthnumber

Depth of the article

Example: 5.2
grossWeightnumber

Gross weight of the article

Example: 1.75
netWeightnumber

Net weight of the article

Example: 1.5
warehouseobject(ApiWarehouseListReadDto)required
warehouse.​idinteger(int32)required

Unique identifier of the entity

Example: 1
warehouse.​codestringrequired

Warehouse code (unique per warehouse).

Example: "ALM01"
warehouse.​descriptionstringrequired

Warehouse description.

Example: "Central warehouse"
accumulateWarehouseboolean

Indicates if the warehouse accumulates stock

Example: true
unitWarehouseobject(ApiUnitTypeListReadDto)
salesAccountobject(ApiChartAccountListReadDto)
purchasingAccountobject(ApiChartAccountListReadDto)
baseCombinationobject(ApiArticleCombinationDefaultReadDto)
articleCombinationsArray of objects(ApiArticleCombinationReadDto)

List of article combinations

observationsArray of objects(ApiArticleObservationListReadDto)

List of observations about the article

filesArray of objects(ApiArticleFileListReadDto)

List of files associated with the article

tagsArray of strings

List of tags associated with the article

Example: ["premium","leather","fashion"]
showAttribute1boolean

Indicates if attribute 1 should be displayed

Example: true
showAttribute2boolean

Indicates if attribute 2 should be displayed

Example: false
showAttribute3boolean

Indicates if attribute 3 should be displayed

Example: false
showAttribute4boolean

Indicates if attribute 4 should be displayed

Example: false
showAttribute5boolean

Indicates if attribute 5 should be displayed

Example: false
stockQuantitynumber

Current stock quantity

Example: 100.5
salesQuantitynumber

Sales quantity

Example: 75
cancelledQuantitynumber

Cancelled quantity

Example: 5
outboundQuantitynumber

Outbound quantity

Example: 80
pendingDeliveryQuantitynumber

Pending delivery quantity

Example: 25
purchaseQuantitynumber

Purchase quantity

Example: 150
providerCancelledQuantitynumber

Provider cancelled quantity

Example: 10
inboundQuantitynumber

Inbound quantity

Example: 120
pendingReceiptQuantitynumber

Pending receipt quantity

Example: 30
description2string[ 0 .. 100 ] characters

Secondary description of the article

Example: "Available in multiple colors"
articleTypestring(ApiArticleTypeEnum)required
Enum"PACKAGING""EXPENSE""RAW_MATERIAL""MERCHANDISE""OTHERS""FINISHED_PRODUCT""SEMI_FINISHED""SERVICE""ADVERTISING"
Example: "PRODUCT"
phytosanitaryProductobject(ApiPhytosanitaryProductListReadDto)
batchControlboolean

Indicates if batch control is enabled for the article

Example: true
serialNumberControlboolean

Indicates if serial number control is enabled for the article

Example: false
category1object(ApiCategoryListReadDto)
category2object(ApiCategoryListReadDto)
category3object(ApiCategoryListReadDto)
category4object(ApiCategoryListReadDto)
Response
application/json
{
  "id": 1,
  "code": "ART123",
  "description": "Premium leather jacket",
  "vatType": "STANDARD",
  "height": 10.5,
  "width": 20.3,
  "depth": 5.2,
  "grossWeight": 1.75,
  "netWeight": 1.5,
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse"
  },
  "accumulateWarehouse": true,
  "unitWarehouse": {
    "id": 1,
    "code": "string",
    "description": "string",
    "isoCode": "MTR"
  },
  "salesAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "purchasingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "baseCombination": {
    "id": 1,
    "defaultArticleCombinationSupplier": { … },
    "defaultItemSaleRate": { … },
    "defaultEan": { … },
    "article": "ART-00123",
    "articleId": 1024,
    "articleType": "MERCHANDISE",
    "unitWarehouseId": 15,
    "articleDescription": "Men's cotton T-shirt, size L",
    "attribute1": { … },
    "attribute2": { … },
    "attribute3": { … },
    "attribute4": { … },
    "attribute5": { … },
    "seasonId": 2024,
    "season": "Spring/Summer 2024",
    "category1": "Clothing",
    "category2": "Men's Wear",
    "category3": "T-Shirts",
    "category4": "Casual",
    "description": "Short-sleeve cotton T-shirt with round neck.",
    "active": true,
    "articleVatType": "STANDARD",
    "assortment": { … },
    "sizeRange": { … },
    "serialNumberControl": false,
    "batchControl": true
  },
  "articleCombinations": [
    { … }
  ],
  "observations": [
    { … }
  ],
  "files": [
    { … }
  ],
  "tags": [
    "premium",
    "leather",
    "fashion"
  ],
  "showAttribute1": true,
  "showAttribute2": false,
  "showAttribute3": false,
  "showAttribute4": false,
  "showAttribute5": false,
  "stockQuantity": 100.5,
  "salesQuantity": 75,
  "cancelledQuantity": 5,
  "outboundQuantity": 80,
  "pendingDeliveryQuantity": 25,
  "purchaseQuantity": 150,
  "providerCancelledQuantity": 10,
  "inboundQuantity": 120,
  "pendingReceiptQuantity": 30,
  "description2": "Available in multiple colors",
  "articleType": "MERCHANDISE",
  "phytosanitaryProduct": {
    "id": 1,
    "code": "string",
    "description": "string",
    "headline": "string",
    "form": "string",
    "cancellationDate": "2019-08-24",
    "saleDeadline": "2019-08-24"
  },
  "batchControl": true,
  "serialNumberControl": false,
  "category1": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category2": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category3": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category4": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  }
}

Update Service

Request

Update a specific service.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
baseCombinationinteger(int32)

ID of the base combination

Example: 1
codestring[ 0 .. 20 ] charactersrequired

Code of the article

Example: "ART123"
descriptionstring[ 0 .. 100 ] characters

Description of the article

Example: "Premium leather jacket"
vatTypestring(ApiArticleVatTypeEnum)required
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "STANDARD"
heightnumber

Height of the article

Example: 10.5
widthnumber

Width of the article

Example: 20.3
depthnumber

Depth of the article

Example: 5.2
grossWeightnumber

Gross weight of the article

Example: 1.75
netWeightnumber

Net weight of the article

Example: 1.5
warehouseinteger(int32)required

ID of the warehouse

Example: 1
accumulateWarehouseboolean

Indicates if the warehouse accumulates stock

Example: true
unitWarehouseinteger(int32)

ID of the unit type used in the warehouse

Example: 2
salesAccountinteger(int32)

ID of the sales account

Example: 401
purchasingAccountinteger(int32)

ID of the purchasing account

Example: 601
articleCombinationsArray of objects(ApiArticleCombinationWriteDto)

List of article combinations

observationsArray of objects(ApiArticleObservationWriteDto)

List of observations about the article

filesArray of objects(ApiArticleFileWriteDto)

List of files associated with the article

tagsArray of strings

List of tags associated with the article

Example: ["premium","leather","fashion"]
showAttribute1boolean

Indicates if attribute 1 should be displayed

Example: true
showAttribute2boolean

Indicates if attribute 2 should be displayed

Example: false
showAttribute3boolean

Indicates if attribute 3 should be displayed

Example: false
showAttribute4boolean

Indicates if attribute 4 should be displayed

Example: false
showAttribute5boolean

Indicates if attribute 5 should be displayed

Example: false
stockQuantitynumber
salesQuantitynumber
cancelledQuantitynumber
outboundQuantitynumber
pendingDeliveryQuantitynumber
purchaseQuantitynumber
providerCancelledQuantitynumber
inboundQuantitynumber
pendingReceiptQuantitynumber
description2string[ 0 .. 100 ] characters

Secondary description of the article

Example: "Available in multiple colors"
articleTypestring(ApiArticleTypeEnum)
Enum"PACKAGING""EXPENSE""RAW_MATERIAL""MERCHANDISE""OTHERS""FINISHED_PRODUCT""SEMI_FINISHED""SERVICE""ADVERTISING"
Example: "PRODUCT"
batchControlboolean

Indicates if batch control is enabled for the article

Example: true
serialNumberControlboolean

Indicates if serial number control is enabled for the article

Example: false
category1integer(int32)

ID of the primary category

Example: 1
category2integer(int32)

ID of the secondary category

Example: 2
category3integer(int32)

ID of the tertiary category

Example: 3
category4integer(int32)

ID of the quaternary category

Example: 4
phytosanitaryProductinteger(int32)

ID of the phytosanitary product

Example: 101
curl -i -X PUT \
  'https://api.prana.software/api/v1/service/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "baseCombination": 1,
    "code": "ART123",
    "description": "Premium leather jacket",
    "vatType": "STANDARD",
    "height": 10.5,
    "width": 20.3,
    "depth": 5.2,
    "grossWeight": 1.75,
    "netWeight": 1.5,
    "warehouse": 1,
    "accumulateWarehouse": true,
    "unitWarehouse": 2,
    "salesAccount": 401,
    "purchasingAccount": 601,
    "articleCombinations": [
      {
        "id": 123,
        "defaultArticleCombinationSupplier": 5,
        "defaultItemSaleRate": 2,
        "defaultEan": 1,
        "article": 1001,
        "attribute1": 15,
        "attribute2": 22,
        "attribute3": 33,
        "attribute4": 44,
        "attribute5": 55,
        "active": true,
        "creationDate": "2025-01-15",
        "inactiveDate": "2025-12-31",
        "ean": 8412345678901,
        "minimum": 0,
        "articleCombinationSuppliers": [
          {
            "id": 123,
            "articleCombination": 456,
            "supplierCode": "SUP001",
            "supplierReference": "REF123",
            "supplierPrice": 29.99,
            "currency": "EUR",
            "mainSupplier": true,
            "purchasingNotes": "Order in advance during peak season",
            "supplier": 789,
            "usual": true,
            "purchasePrice": 25.99,
            "unitType": 1,
            "sizeRange": 101,
            "changeDate": "2023-05-15",
            "previousPrice": 24.5,
            "netPrice": 21.48,
            "netPriceInCompanyCurrency": 19.5,
            "bomPrice": 18.75,
            "bomPriceInCompanyCurrency": 17,
            "minimumPurchase": 10,
            "yourReference": "REF-T101",
            "discount": 5,
            "waitTime": 5,
            "observations": "Special packaging required",
            "futurePrice": 23.99,
            "multiplesOf": 5
          }
        ],
        "itemSaleRates": [
          {
            "id": 101,
            "rate": 7,
            "articleCombination": 24,
            "price": 31.2,
            "price2": 29.99,
            "rateCode": 42,
            "season": 2025,
            "sizeRange": 3
          }
        ],
        "articleCombinationSizeRanges": [
          {
            "id": 123,
            "articleCombination": 456,
            "sizeRange": 789,
            "assortment": 101,
            "inactive": false,
            "height": 10.5,
            "width": 20.3,
            "depth": 15.7,
            "grossWeight": 500.25,
            "netWeight": 450.75,
            "ean": 8412345678901,
            "cactive": true
          }
        ],
        "season": 0,
        "manufactured": true,
        "maxProductionOrder": 0,
        "maxSizePrint": 0,
        "bought": true,
        "dontOrder": true,
        "description": "string",
        "observations": "string",
        "family": 0,
        "activeB2B": true,
        "availabilityB2B": "STOCK",
        "visibleDateB2B": "2019-08-24",
        "dtoB2B": 0,
        "activeMobility": true,
        "activeTPV": true,
        "activePrestashop": true,
        "maximum": 0,
        "tariffItem": "string",
        "pictures": [
          {
            "id": 0,
            "token": "string",
            "pictureFileName": "string",
            "pictureFileExtension": "string",
            "viewOrder": 0
          }
        ]
      }
    ],
    "observations": [
      {
        "id": 0,
        "title": "string",
        "description": "string"
      }
    ],
    "files": [
      {
        "id": 0,
        "token": "string",
        "fileName": "string",
        "fileExtension": "string",
        "fileSize": 0
      }
    ],
    "tags": [
      "premium",
      "leather",
      "fashion"
    ],
    "showAttribute1": true,
    "showAttribute2": false,
    "showAttribute3": false,
    "showAttribute4": false,
    "showAttribute5": false,
    "stockQuantity": 0,
    "salesQuantity": 0,
    "cancelledQuantity": 0,
    "outboundQuantity": 0,
    "pendingDeliveryQuantity": 0,
    "purchaseQuantity": 0,
    "providerCancelledQuantity": 0,
    "inboundQuantity": 0,
    "pendingReceiptQuantity": 0,
    "description2": "Available in multiple colors",
    "articleType": "MERCHANDISE",
    "batchControl": true,
    "serialNumberControl": false,
    "category1": 1,
    "category2": 2,
    "category3": 3,
    "category4": 4,
    "phytosanitaryProduct": 101
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestring[ 0 .. 20 ] charactersrequired

Code of the article

Example: "ART123"
descriptionstring[ 0 .. 100 ] characters

Description of the article

Example: "Premium leather jacket"
vatTypestring(ApiArticleVatTypeEnum)required
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "STANDARD"
heightnumber

Height of the article

Example: 10.5
widthnumber

Width of the article

Example: 20.3
depthnumber

Depth of the article

Example: 5.2
grossWeightnumber

Gross weight of the article

Example: 1.75
netWeightnumber

Net weight of the article

Example: 1.5
warehouseobject(ApiWarehouseListReadDto)required
warehouse.​idinteger(int32)required

Unique identifier of the entity

Example: 1
warehouse.​codestringrequired

Warehouse code (unique per warehouse).

Example: "ALM01"
warehouse.​descriptionstringrequired

Warehouse description.

Example: "Central warehouse"
accumulateWarehouseboolean

Indicates if the warehouse accumulates stock

Example: true
unitWarehouseobject(ApiUnitTypeListReadDto)
salesAccountobject(ApiChartAccountListReadDto)
purchasingAccountobject(ApiChartAccountListReadDto)
baseCombinationobject(ApiArticleCombinationDefaultReadDto)
articleCombinationsArray of objects(ApiArticleCombinationReadDto)

List of article combinations

observationsArray of objects(ApiArticleObservationListReadDto)

List of observations about the article

filesArray of objects(ApiArticleFileListReadDto)

List of files associated with the article

tagsArray of strings

List of tags associated with the article

Example: ["premium","leather","fashion"]
showAttribute1boolean

Indicates if attribute 1 should be displayed

Example: true
showAttribute2boolean

Indicates if attribute 2 should be displayed

Example: false
showAttribute3boolean

Indicates if attribute 3 should be displayed

Example: false
showAttribute4boolean

Indicates if attribute 4 should be displayed

Example: false
showAttribute5boolean

Indicates if attribute 5 should be displayed

Example: false
stockQuantitynumber

Current stock quantity

Example: 100.5
salesQuantitynumber

Sales quantity

Example: 75
cancelledQuantitynumber

Cancelled quantity

Example: 5
outboundQuantitynumber

Outbound quantity

Example: 80
pendingDeliveryQuantitynumber

Pending delivery quantity

Example: 25
purchaseQuantitynumber

Purchase quantity

Example: 150
providerCancelledQuantitynumber

Provider cancelled quantity

Example: 10
inboundQuantitynumber

Inbound quantity

Example: 120
pendingReceiptQuantitynumber

Pending receipt quantity

Example: 30
description2string[ 0 .. 100 ] characters

Secondary description of the article

Example: "Available in multiple colors"
articleTypestring(ApiArticleTypeEnum)required
Enum"PACKAGING""EXPENSE""RAW_MATERIAL""MERCHANDISE""OTHERS""FINISHED_PRODUCT""SEMI_FINISHED""SERVICE""ADVERTISING"
Example: "PRODUCT"
phytosanitaryProductobject(ApiPhytosanitaryProductListReadDto)
batchControlboolean

Indicates if batch control is enabled for the article

Example: true
serialNumberControlboolean

Indicates if serial number control is enabled for the article

Example: false
category1object(ApiCategoryListReadDto)
category2object(ApiCategoryListReadDto)
category3object(ApiCategoryListReadDto)
category4object(ApiCategoryListReadDto)
Response
application/json
{
  "id": 1,
  "code": "ART123",
  "description": "Premium leather jacket",
  "vatType": "STANDARD",
  "height": 10.5,
  "width": 20.3,
  "depth": 5.2,
  "grossWeight": 1.75,
  "netWeight": 1.5,
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse"
  },
  "accumulateWarehouse": true,
  "unitWarehouse": {
    "id": 1,
    "code": "string",
    "description": "string",
    "isoCode": "MTR"
  },
  "salesAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "purchasingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "baseCombination": {
    "id": 1,
    "defaultArticleCombinationSupplier": { … },
    "defaultItemSaleRate": { … },
    "defaultEan": { … },
    "article": "ART-00123",
    "articleId": 1024,
    "articleType": "MERCHANDISE",
    "unitWarehouseId": 15,
    "articleDescription": "Men's cotton T-shirt, size L",
    "attribute1": { … },
    "attribute2": { … },
    "attribute3": { … },
    "attribute4": { … },
    "attribute5": { … },
    "seasonId": 2024,
    "season": "Spring/Summer 2024",
    "category1": "Clothing",
    "category2": "Men's Wear",
    "category3": "T-Shirts",
    "category4": "Casual",
    "description": "Short-sleeve cotton T-shirt with round neck.",
    "active": true,
    "articleVatType": "STANDARD",
    "assortment": { … },
    "sizeRange": { … },
    "serialNumberControl": false,
    "batchControl": true
  },
  "articleCombinations": [
    { … }
  ],
  "observations": [
    { … }
  ],
  "files": [
    { … }
  ],
  "tags": [
    "premium",
    "leather",
    "fashion"
  ],
  "showAttribute1": true,
  "showAttribute2": false,
  "showAttribute3": false,
  "showAttribute4": false,
  "showAttribute5": false,
  "stockQuantity": 100.5,
  "salesQuantity": 75,
  "cancelledQuantity": 5,
  "outboundQuantity": 80,
  "pendingDeliveryQuantity": 25,
  "purchaseQuantity": 150,
  "providerCancelledQuantity": 10,
  "inboundQuantity": 120,
  "pendingReceiptQuantity": 30,
  "description2": "Available in multiple colors",
  "articleType": "MERCHANDISE",
  "phytosanitaryProduct": {
    "id": 1,
    "code": "string",
    "description": "string",
    "headline": "string",
    "form": "string",
    "cancellationDate": "2019-08-24",
    "saleDeadline": "2019-08-24"
  },
  "batchControl": true,
  "serialNumberControl": false,
  "category1": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category2": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category3": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category4": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  }
}

Delete Service

Request

Delete specific service.

Path
idinteger(int32)required
curl -i -X DELETE \
  'https://api.prana.software/api/v1/service/{id}'

Responses

OK

Create Service

Request

Create a new service.

Bodyapplication/jsonrequired
baseCombinationinteger(int32)

ID of the base combination

Example: 1
codestring[ 0 .. 20 ] charactersrequired

Code of the article

Example: "ART123"
descriptionstring[ 0 .. 100 ] characters

Description of the article

Example: "Premium leather jacket"
vatTypestring(ApiArticleVatTypeEnum)required
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "STANDARD"
heightnumber

Height of the article

Example: 10.5
widthnumber

Width of the article

Example: 20.3
depthnumber

Depth of the article

Example: 5.2
grossWeightnumber

Gross weight of the article

Example: 1.75
netWeightnumber

Net weight of the article

Example: 1.5
warehouseinteger(int32)required

ID of the warehouse

Example: 1
accumulateWarehouseboolean

Indicates if the warehouse accumulates stock

Example: true
unitWarehouseinteger(int32)

ID of the unit type used in the warehouse

Example: 2
salesAccountinteger(int32)

ID of the sales account

Example: 401
purchasingAccountinteger(int32)

ID of the purchasing account

Example: 601
articleCombinationsArray of objects(ApiArticleCombinationWriteDto)

List of article combinations

observationsArray of objects(ApiArticleObservationWriteDto)

List of observations about the article

filesArray of objects(ApiArticleFileWriteDto)

List of files associated with the article

tagsArray of strings

List of tags associated with the article

Example: ["premium","leather","fashion"]
showAttribute1boolean

Indicates if attribute 1 should be displayed

Example: true
showAttribute2boolean

Indicates if attribute 2 should be displayed

Example: false
showAttribute3boolean

Indicates if attribute 3 should be displayed

Example: false
showAttribute4boolean

Indicates if attribute 4 should be displayed

Example: false
showAttribute5boolean

Indicates if attribute 5 should be displayed

Example: false
stockQuantitynumber
salesQuantitynumber
cancelledQuantitynumber
outboundQuantitynumber
pendingDeliveryQuantitynumber
purchaseQuantitynumber
providerCancelledQuantitynumber
inboundQuantitynumber
pendingReceiptQuantitynumber
description2string[ 0 .. 100 ] characters

Secondary description of the article

Example: "Available in multiple colors"
articleTypestring(ApiArticleTypeEnum)
Enum"PACKAGING""EXPENSE""RAW_MATERIAL""MERCHANDISE""OTHERS""FINISHED_PRODUCT""SEMI_FINISHED""SERVICE""ADVERTISING"
Example: "PRODUCT"
batchControlboolean

Indicates if batch control is enabled for the article

Example: true
serialNumberControlboolean

Indicates if serial number control is enabled for the article

Example: false
category1integer(int32)

ID of the primary category

Example: 1
category2integer(int32)

ID of the secondary category

Example: 2
category3integer(int32)

ID of the tertiary category

Example: 3
category4integer(int32)

ID of the quaternary category

Example: 4
phytosanitaryProductinteger(int32)

ID of the phytosanitary product

Example: 101
curl -i -X POST \
  https://api.prana.software/api/v1/service \
  -H 'Content-Type: application/json' \
  -d '{
    "baseCombination": 1,
    "code": "ART123",
    "description": "Premium leather jacket",
    "vatType": "STANDARD",
    "height": 10.5,
    "width": 20.3,
    "depth": 5.2,
    "grossWeight": 1.75,
    "netWeight": 1.5,
    "warehouse": 1,
    "accumulateWarehouse": true,
    "unitWarehouse": 2,
    "salesAccount": 401,
    "purchasingAccount": 601,
    "articleCombinations": [
      {
        "id": 123,
        "defaultArticleCombinationSupplier": 5,
        "defaultItemSaleRate": 2,
        "defaultEan": 1,
        "article": 1001,
        "attribute1": 15,
        "attribute2": 22,
        "attribute3": 33,
        "attribute4": 44,
        "attribute5": 55,
        "active": true,
        "creationDate": "2025-01-15",
        "inactiveDate": "2025-12-31",
        "ean": 8412345678901,
        "minimum": 0,
        "articleCombinationSuppliers": [
          {
            "id": 123,
            "articleCombination": 456,
            "supplierCode": "SUP001",
            "supplierReference": "REF123",
            "supplierPrice": 29.99,
            "currency": "EUR",
            "mainSupplier": true,
            "purchasingNotes": "Order in advance during peak season",
            "supplier": 789,
            "usual": true,
            "purchasePrice": 25.99,
            "unitType": 1,
            "sizeRange": 101,
            "changeDate": "2023-05-15",
            "previousPrice": 24.5,
            "netPrice": 21.48,
            "netPriceInCompanyCurrency": 19.5,
            "bomPrice": 18.75,
            "bomPriceInCompanyCurrency": 17,
            "minimumPurchase": 10,
            "yourReference": "REF-T101",
            "discount": 5,
            "waitTime": 5,
            "observations": "Special packaging required",
            "futurePrice": 23.99,
            "multiplesOf": 5
          }
        ],
        "itemSaleRates": [
          {
            "id": 101,
            "rate": 7,
            "articleCombination": 24,
            "price": 31.2,
            "price2": 29.99,
            "rateCode": 42,
            "season": 2025,
            "sizeRange": 3
          }
        ],
        "articleCombinationSizeRanges": [
          {
            "id": 123,
            "articleCombination": 456,
            "sizeRange": 789,
            "assortment": 101,
            "inactive": false,
            "height": 10.5,
            "width": 20.3,
            "depth": 15.7,
            "grossWeight": 500.25,
            "netWeight": 450.75,
            "ean": 8412345678901,
            "cactive": true
          }
        ],
        "season": 0,
        "manufactured": true,
        "maxProductionOrder": 0,
        "maxSizePrint": 0,
        "bought": true,
        "dontOrder": true,
        "description": "string",
        "observations": "string",
        "family": 0,
        "activeB2B": true,
        "availabilityB2B": "STOCK",
        "visibleDateB2B": "2019-08-24",
        "dtoB2B": 0,
        "activeMobility": true,
        "activeTPV": true,
        "activePrestashop": true,
        "maximum": 0,
        "tariffItem": "string",
        "pictures": [
          {
            "id": 0,
            "token": "string",
            "pictureFileName": "string",
            "pictureFileExtension": "string",
            "viewOrder": 0
          }
        ]
      }
    ],
    "observations": [
      {
        "id": 0,
        "title": "string",
        "description": "string"
      }
    ],
    "files": [
      {
        "id": 0,
        "token": "string",
        "fileName": "string",
        "fileExtension": "string",
        "fileSize": 0
      }
    ],
    "tags": [
      "premium",
      "leather",
      "fashion"
    ],
    "showAttribute1": true,
    "showAttribute2": false,
    "showAttribute3": false,
    "showAttribute4": false,
    "showAttribute5": false,
    "stockQuantity": 0,
    "salesQuantity": 0,
    "cancelledQuantity": 0,
    "outboundQuantity": 0,
    "pendingDeliveryQuantity": 0,
    "purchaseQuantity": 0,
    "providerCancelledQuantity": 0,
    "inboundQuantity": 0,
    "pendingReceiptQuantity": 0,
    "description2": "Available in multiple colors",
    "articleType": "MERCHANDISE",
    "batchControl": true,
    "serialNumberControl": false,
    "category1": 1,
    "category2": 2,
    "category3": 3,
    "category4": 4,
    "phytosanitaryProduct": 101
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestring[ 0 .. 20 ] charactersrequired

Code of the article

Example: "ART123"
descriptionstring[ 0 .. 100 ] characters

Description of the article

Example: "Premium leather jacket"
vatTypestring(ApiArticleVatTypeEnum)required
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "STANDARD"
heightnumber

Height of the article

Example: 10.5
widthnumber

Width of the article

Example: 20.3
depthnumber

Depth of the article

Example: 5.2
grossWeightnumber

Gross weight of the article

Example: 1.75
netWeightnumber

Net weight of the article

Example: 1.5
warehouseobject(ApiWarehouseListReadDto)required
warehouse.​idinteger(int32)required

Unique identifier of the entity

Example: 1
warehouse.​codestringrequired

Warehouse code (unique per warehouse).

Example: "ALM01"
warehouse.​descriptionstringrequired

Warehouse description.

Example: "Central warehouse"
accumulateWarehouseboolean

Indicates if the warehouse accumulates stock

Example: true
unitWarehouseobject(ApiUnitTypeListReadDto)
salesAccountobject(ApiChartAccountListReadDto)
purchasingAccountobject(ApiChartAccountListReadDto)
baseCombinationobject(ApiArticleCombinationDefaultReadDto)
articleCombinationsArray of objects(ApiArticleCombinationReadDto)

List of article combinations

observationsArray of objects(ApiArticleObservationListReadDto)

List of observations about the article

filesArray of objects(ApiArticleFileListReadDto)

List of files associated with the article

tagsArray of strings

List of tags associated with the article

Example: ["premium","leather","fashion"]
showAttribute1boolean

Indicates if attribute 1 should be displayed

Example: true
showAttribute2boolean

Indicates if attribute 2 should be displayed

Example: false
showAttribute3boolean

Indicates if attribute 3 should be displayed

Example: false
showAttribute4boolean

Indicates if attribute 4 should be displayed

Example: false
showAttribute5boolean

Indicates if attribute 5 should be displayed

Example: false
stockQuantitynumber

Current stock quantity

Example: 100.5
salesQuantitynumber

Sales quantity

Example: 75
cancelledQuantitynumber

Cancelled quantity

Example: 5
outboundQuantitynumber

Outbound quantity

Example: 80
pendingDeliveryQuantitynumber

Pending delivery quantity

Example: 25
purchaseQuantitynumber

Purchase quantity

Example: 150
providerCancelledQuantitynumber

Provider cancelled quantity

Example: 10
inboundQuantitynumber

Inbound quantity

Example: 120
pendingReceiptQuantitynumber

Pending receipt quantity

Example: 30
description2string[ 0 .. 100 ] characters

Secondary description of the article

Example: "Available in multiple colors"
articleTypestring(ApiArticleTypeEnum)required
Enum"PACKAGING""EXPENSE""RAW_MATERIAL""MERCHANDISE""OTHERS""FINISHED_PRODUCT""SEMI_FINISHED""SERVICE""ADVERTISING"
Example: "PRODUCT"
phytosanitaryProductobject(ApiPhytosanitaryProductListReadDto)
batchControlboolean

Indicates if batch control is enabled for the article

Example: true
serialNumberControlboolean

Indicates if serial number control is enabled for the article

Example: false
category1object(ApiCategoryListReadDto)
category2object(ApiCategoryListReadDto)
category3object(ApiCategoryListReadDto)
category4object(ApiCategoryListReadDto)
Response
application/json
{
  "id": 1,
  "code": "ART123",
  "description": "Premium leather jacket",
  "vatType": "STANDARD",
  "height": 10.5,
  "width": 20.3,
  "depth": 5.2,
  "grossWeight": 1.75,
  "netWeight": 1.5,
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse"
  },
  "accumulateWarehouse": true,
  "unitWarehouse": {
    "id": 1,
    "code": "string",
    "description": "string",
    "isoCode": "MTR"
  },
  "salesAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "purchasingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "baseCombination": {
    "id": 1,
    "defaultArticleCombinationSupplier": { … },
    "defaultItemSaleRate": { … },
    "defaultEan": { … },
    "article": "ART-00123",
    "articleId": 1024,
    "articleType": "MERCHANDISE",
    "unitWarehouseId": 15,
    "articleDescription": "Men's cotton T-shirt, size L",
    "attribute1": { … },
    "attribute2": { … },
    "attribute3": { … },
    "attribute4": { … },
    "attribute5": { … },
    "seasonId": 2024,
    "season": "Spring/Summer 2024",
    "category1": "Clothing",
    "category2": "Men's Wear",
    "category3": "T-Shirts",
    "category4": "Casual",
    "description": "Short-sleeve cotton T-shirt with round neck.",
    "active": true,
    "articleVatType": "STANDARD",
    "assortment": { … },
    "sizeRange": { … },
    "serialNumberControl": false,
    "batchControl": true
  },
  "articleCombinations": [
    { … }
  ],
  "observations": [
    { … }
  ],
  "files": [
    { … }
  ],
  "tags": [
    "premium",
    "leather",
    "fashion"
  ],
  "showAttribute1": true,
  "showAttribute2": false,
  "showAttribute3": false,
  "showAttribute4": false,
  "showAttribute5": false,
  "stockQuantity": 100.5,
  "salesQuantity": 75,
  "cancelledQuantity": 5,
  "outboundQuantity": 80,
  "pendingDeliveryQuantity": 25,
  "purchaseQuantity": 150,
  "providerCancelledQuantity": 10,
  "inboundQuantity": 120,
  "pendingReceiptQuantity": 30,
  "description2": "Available in multiple colors",
  "articleType": "MERCHANDISE",
  "phytosanitaryProduct": {
    "id": 1,
    "code": "string",
    "description": "string",
    "headline": "string",
    "form": "string",
    "cancellationDate": "2019-08-24",
    "saleDeadline": "2019-08-24"
  },
  "batchControl": true,
  "serialNumberControl": false,
  "category1": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category2": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category3": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  },
  "category4": {
    "id": 1,
    "code": "FOOTWEAR",
    "description": "Footwear and shoes"
  }
}

List Services

Request

Get all your services.

Bodyapplication/jsonrequired
conditionobject(ApiCondition)
sortCriteriaArray of objects(ApiSortDto)

List of sorting criteria to apply

pageNumberinteger(int32)required

Page number to retrieve (0-based)

Example: 0
pageSizeinteger(int32)required

Number of items per page

Example: 20
curl -i -X POST \
  https://api.prana.software/api/v1/service/search \
  -H 'Content-Type: application/json' \
  -d '{
    "condition": {
      "field": "name",
      "value": "Example Value",
      "type": "EQ",
      "endValue": 100,
      "innerConditions": [
        {}
      ],
      "conditionType": "AND",
      "empty": false,
      "compareFields": false
    },
    "sortCriteria": [
      {
        "sortField": "name",
        "sortDirection": "ASC"
      }
    ],
    "pageNumber": 0,
    "pageSize": 20
  }'

Responses

OK

Bodyapplication/json
dataArray of objects(ApiArticleListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​codestringrequired

Code of the article

Example: "ART123"
data[].​descriptionstring

Description of the article

Example: "Premium leather jacket"
data[].​description2string

Secondary description of the article

Example: "Available in multiple colors"
data[].​warehousestringrequired

Warehouse associated with the article

Example: "MAIN"
data[].​category1string

Primary category of the article

Example: "Clothing"
data[].​category2string

Secondary category of the article

Example: "Jackets"
data[].​category3string

Tertiary category of the article

Example: "Leather"
data[].​category4string

Quaternary category of the article

Example: "Premium"
data[].​vatTypestring(ApiArticleVatTypeEnum)required
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "STANDARD"
data[].​seasonstring

Season associated with the article

Example: "FALL2023"
data[].​familystring

Family of the article

Example: "OUTDOOR"
data[].​baseCombinationobject(ApiArticleCombinationListReadDto)
data[].​tagsArray of strings

List of tags associated with the article

Example: ["premium","leather","fashion"]
data[].​showAttribute1boolean

Indicates if attribute 1 should be displayed

Example: true
data[].​showAttribute2boolean

Indicates if attribute 2 should be displayed

Example: false
data[].​showAttribute3boolean

Indicates if attribute 3 should be displayed

Example: false
data[].​showAttribute4boolean

Indicates if attribute 4 should be displayed

Example: false
data[].​showAttribute5boolean

Indicates if attribute 5 should be displayed

Example: false
pageinteger(int32)required

Current page number (0-based)

Example: 0
totalinteger(int32)required

Total number of items across all pages

Example: 150
pagesinteger(int64)required

Last page number (0-based)

Example: 14
sizeinteger(int32)required

Number of items per page

Example: 10
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "total": 150,
  "pages": 14,
  "size": 10
}

Company

Manage your Company

Operations

PurchaseDeliveryNote

Manage your PurchaseDeliveryNotes

Operations