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

Get Warehouse

Request

Get a specific warehouse.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Warehouse code (unique per warehouse).

Example: "ALM01"
nationalIdentityCardstring

National Identity Card associated to the warehouse.

Example: "12345678A"
descriptionstringrequired

Warehouse description.

Example: "Central warehouse"
addressstring

Street address of the warehouse.

Example: "Av. de la Industria, 23"
postalCodestring

Postal code.

Example: "03001"
populationstring

Population or locality (city/town) of the warehouse.

Example: "Alicante"
countryobject(ApiCountryListReadDto)
stateobject(ApiStateListReadDto)
phone1string

First contact phone number.

Example: "+34965123456"
phone2string

Second contact phone number.

Example: "+34965111111"
emailstring

Contact email address for the warehouse.

Example: "warehouse@company.com"
byDefaultboolean

True if this is the default warehouse.

Example: true
Response
application/json
{
  "id": 1,
  "code": "ALM01",
  "nationalIdentityCard": "12345678A",
  "description": "Central warehouse",
  "address": "Av. de la Industria, 23",
  "postalCode": "03001",
  "population": "Alicante",
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "state": {
    "id": 1,
    "code": "string",
    "description": "string",
    "country": { … },
    "isoCode": "string"
  },
  "phone1": "+34965123456",
  "phone2": "+34965111111",
  "email": "warehouse@company.com",
  "byDefault": true
}

Update Warehouse

Request

Update a specific warehouse.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
codestring[ 0 .. 10 ] charactersrequired

Warehouse code (unique).

Example: "ALM01"
nationalIdentityCardstring[ 0 .. 20 ] characters

National Identity Card associated to the warehouse.

Example: "12345678A"
descriptionstring[ 0 .. 100 ] charactersrequired
addressstring[ 0 .. 100 ] characters
postalCodestring[ 0 .. 10 ] characters
populationstring[ 0 .. 100 ] characters
countryinteger(int32)
stateinteger(int32)
phone1string[ 0 .. 20 ] characters
phone2string[ 0 .. 20 ] characters
emailstring[ 0 .. 250 ] characters
byDefaultboolean
curl -i -X PUT \
  'https://api.prana.software/api/v1/warehouse/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "ALM01",
    "nationalIdentityCard": "12345678A",
    "description": "string",
    "address": "string",
    "postalCode": "string",
    "population": "string",
    "country": 0,
    "state": 0,
    "phone1": "string",
    "phone2": "string",
    "email": "string",
    "byDefault": true
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Warehouse code (unique per warehouse).

Example: "ALM01"
nationalIdentityCardstring

National Identity Card associated to the warehouse.

Example: "12345678A"
descriptionstringrequired

Warehouse description.

Example: "Central warehouse"
addressstring

Street address of the warehouse.

Example: "Av. de la Industria, 23"
postalCodestring

Postal code.

Example: "03001"
populationstring

Population or locality (city/town) of the warehouse.

Example: "Alicante"
countryobject(ApiCountryListReadDto)
stateobject(ApiStateListReadDto)
phone1string

First contact phone number.

Example: "+34965123456"
phone2string

Second contact phone number.

Example: "+34965111111"
emailstring

Contact email address for the warehouse.

Example: "warehouse@company.com"
byDefaultboolean

True if this is the default warehouse.

Example: true
Response
application/json
{
  "id": 1,
  "code": "ALM01",
  "nationalIdentityCard": "12345678A",
  "description": "Central warehouse",
  "address": "Av. de la Industria, 23",
  "postalCode": "03001",
  "population": "Alicante",
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "state": {
    "id": 1,
    "code": "string",
    "description": "string",
    "country": { … },
    "isoCode": "string"
  },
  "phone1": "+34965123456",
  "phone2": "+34965111111",
  "email": "warehouse@company.com",
  "byDefault": true
}

Delete Warehouse

Request

Delete specific warehouse.

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

Responses

OK

Create Warehouse

Request

Create a new warehouse.

Bodyapplication/jsonrequired
codestring[ 0 .. 10 ] charactersrequired

Warehouse code (unique).

Example: "ALM01"
nationalIdentityCardstring[ 0 .. 20 ] characters

National Identity Card associated to the warehouse.

Example: "12345678A"
descriptionstring[ 0 .. 100 ] charactersrequired
addressstring[ 0 .. 100 ] characters
postalCodestring[ 0 .. 10 ] characters
populationstring[ 0 .. 100 ] characters
countryinteger(int32)
stateinteger(int32)
phone1string[ 0 .. 20 ] characters
phone2string[ 0 .. 20 ] characters
emailstring[ 0 .. 250 ] characters
byDefaultboolean
curl -i -X POST \
  https://api.prana.software/api/v1/warehouse \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "ALM01",
    "nationalIdentityCard": "12345678A",
    "description": "string",
    "address": "string",
    "postalCode": "string",
    "population": "string",
    "country": 0,
    "state": 0,
    "phone1": "string",
    "phone2": "string",
    "email": "string",
    "byDefault": true
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Warehouse code (unique per warehouse).

Example: "ALM01"
nationalIdentityCardstring

National Identity Card associated to the warehouse.

Example: "12345678A"
descriptionstringrequired

Warehouse description.

Example: "Central warehouse"
addressstring

Street address of the warehouse.

Example: "Av. de la Industria, 23"
postalCodestring

Postal code.

Example: "03001"
populationstring

Population or locality (city/town) of the warehouse.

Example: "Alicante"
countryobject(ApiCountryListReadDto)
stateobject(ApiStateListReadDto)
phone1string

First contact phone number.

Example: "+34965123456"
phone2string

Second contact phone number.

Example: "+34965111111"
emailstring

Contact email address for the warehouse.

Example: "warehouse@company.com"
byDefaultboolean

True if this is the default warehouse.

Example: true
Response
application/json
{
  "id": 1,
  "code": "ALM01",
  "nationalIdentityCard": "12345678A",
  "description": "Central warehouse",
  "address": "Av. de la Industria, 23",
  "postalCode": "03001",
  "population": "Alicante",
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "state": {
    "id": 1,
    "code": "string",
    "description": "string",
    "country": { … },
    "isoCode": "string"
  },
  "phone1": "+34965123456",
  "phone2": "+34965111111",
  "email": "warehouse@company.com",
  "byDefault": true
}

List Warehouses

Request

Get all your warehouses.

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/warehouse/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(ApiWarehouseListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​codestringrequired

Warehouse code (unique per warehouse).

Example: "ALM01"
data[].​descriptionstringrequired

Warehouse description.

Example: "Central warehouse"
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
}

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

Company

Manage your Company

Operations

PurchaseDeliveryNote

Manage your PurchaseDeliveryNotes

Operations