Skip to content

Prana API (1.0)

API Prana

Welcome !!! In our developer portal you will find everything you need to interact with our platform.

Our API works with the REST interface through the HTTPS protocol and using the JSON format for processing calls.

All requests are validated against an API Key that can be obtained manually from the Configuration section of the PRANA app.

Our goal is to offer the clearest possible documentation here.

Any suggestions can be sent to: info@prana.software

API Key

To use your API key, you need only call the api with your key in the header as follow:

X-Api-Key

Download OpenAPI description
openapiprana.json
openapiprana.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

Entity Last Update

Manage the last-updated timestamps for entities

Operations

Period

Retrieves the available accounting periods in the app

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

Get State

Request

Get a specific state.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
countryobject(ApiCountryListReadDto)required
country.​idinteger(int32)required

Unique identifier of the entity

Example: 1
country.​codestringrequired

Country code (usually ISO numeric or similar).

Example: 724
country.​descriptionstringrequired

Country description or name.

Example: "Spain"
country.​isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 code for the country.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
country.​customerVatTypestring

Type of VAT scheme for customers in this country.

Example: "GENERAL"
country.​geographicalLocationstring(ApiGeographicalLocationEnum)required

Geographical location of the country. See ApiGeographicalLocation enum for values.

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
codestringrequired
agencyobject(ApiAgencyListReadDto)
descriptionstring
prefixstring
accountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

intrastatCodestring
targetinteger
isoCodestring[ 0 .. 5 ] characters
cycstring
Response
application/json
{
  "id": 1,
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "code": "string",
  "agency": {
    "id": 1,
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "description": "string",
  "prefix": "string",
  "account": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "intrastatCode": "string",
  "target": 0,
  "isoCode": "strin",
  "cyc": "string"
}

Update State

Request

Update a specific state.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
countryinteger(int32)required
codestring[ 0 .. 20 ] charactersrequired
agencyinteger(int32)
descriptionstring[ 0 .. 100 ] characters
prefixstring[ 0 .. 5 ] characters
accountinteger(int32)
intrastatCodestring[ 0 .. 20 ] characters
targetinteger
isoCodestring[ 0 .. 5 ] characters
cycstring[ 0 .. 5 ] characters
curl -i -X PUT \
  'https://api.prana.software/api/v1/state/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "country": 0,
    "code": "string",
    "agency": 0,
    "description": "string",
    "prefix": "strin",
    "account": 0,
    "intrastatCode": "string",
    "target": 0,
    "isoCode": "strin",
    "cyc": "strin"
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
countryobject(ApiCountryListReadDto)required
country.​idinteger(int32)required

Unique identifier of the entity

Example: 1
country.​codestringrequired

Country code (usually ISO numeric or similar).

Example: 724
country.​descriptionstringrequired

Country description or name.

Example: "Spain"
country.​isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 code for the country.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
country.​customerVatTypestring

Type of VAT scheme for customers in this country.

Example: "GENERAL"
country.​geographicalLocationstring(ApiGeographicalLocationEnum)required

Geographical location of the country. See ApiGeographicalLocation enum for values.

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
codestringrequired
agencyobject(ApiAgencyListReadDto)
descriptionstring
prefixstring
accountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

intrastatCodestring
targetinteger
isoCodestring[ 0 .. 5 ] characters
cycstring
Response
application/json
{
  "id": 1,
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "code": "string",
  "agency": {
    "id": 1,
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "description": "string",
  "prefix": "string",
  "account": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "intrastatCode": "string",
  "target": 0,
  "isoCode": "strin",
  "cyc": "string"
}

Delete State

Request

Delete specific state.

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

Responses

OK

Patch State

Request

Patch specific State.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
property name*objectadditional property
curl -i -X PATCH \
  'https://api.prana.software/api/v1/state/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "property1": {},
    "property2": {}
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
countryobject(ApiCountryListReadDto)required
country.​idinteger(int32)required

Unique identifier of the entity

Example: 1
country.​codestringrequired

Country code (usually ISO numeric or similar).

Example: 724
country.​descriptionstringrequired

Country description or name.

Example: "Spain"
country.​isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 code for the country.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
country.​customerVatTypestring

Type of VAT scheme for customers in this country.

Example: "GENERAL"
country.​geographicalLocationstring(ApiGeographicalLocationEnum)required

Geographical location of the country. See ApiGeographicalLocation enum for values.

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
codestringrequired
agencyobject(ApiAgencyListReadDto)
descriptionstring
prefixstring
accountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

intrastatCodestring
targetinteger
isoCodestring[ 0 .. 5 ] characters
cycstring
Response
application/json
{
  "id": 1,
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "code": "string",
  "agency": {
    "id": 1,
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "description": "string",
  "prefix": "string",
  "account": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "intrastatCode": "string",
  "target": 0,
  "isoCode": "strin",
  "cyc": "string"
}

Create State

Request

Create a new state.

Bodyapplication/jsonrequired
countryinteger(int32)required
codestring[ 0 .. 20 ] charactersrequired
agencyinteger(int32)
descriptionstring[ 0 .. 100 ] characters
prefixstring[ 0 .. 5 ] characters
accountinteger(int32)
intrastatCodestring[ 0 .. 20 ] characters
targetinteger
isoCodestring[ 0 .. 5 ] characters
cycstring[ 0 .. 5 ] characters
curl -i -X POST \
  https://api.prana.software/api/v1/state \
  -H 'Content-Type: application/json' \
  -d '{
    "country": 0,
    "code": "string",
    "agency": 0,
    "description": "string",
    "prefix": "strin",
    "account": 0,
    "intrastatCode": "string",
    "target": 0,
    "isoCode": "strin",
    "cyc": "strin"
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
countryobject(ApiCountryListReadDto)required
country.​idinteger(int32)required

Unique identifier of the entity

Example: 1
country.​codestringrequired

Country code (usually ISO numeric or similar).

Example: 724
country.​descriptionstringrequired

Country description or name.

Example: "Spain"
country.​isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 code for the country.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
country.​customerVatTypestring

Type of VAT scheme for customers in this country.

Example: "GENERAL"
country.​geographicalLocationstring(ApiGeographicalLocationEnum)required

Geographical location of the country. See ApiGeographicalLocation enum for values.

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
codestringrequired
agencyobject(ApiAgencyListReadDto)
descriptionstring
prefixstring
accountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

intrastatCodestring
targetinteger
isoCodestring[ 0 .. 5 ] characters
cycstring
Response
application/json
{
  "id": 1,
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "code": "string",
  "agency": {
    "id": 1,
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "description": "string",
  "prefix": "string",
  "account": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "intrastatCode": "string",
  "target": 0,
  "isoCode": "strin",
  "cyc": "string"
}

List States

Request

Get all your states.

Bodyapplication/jsonrequired
conditionobject(ApiCondition)

Condition to filter results

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/state/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(ApiStateListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​codestringrequired
data[].​descriptionstring
data[].​countryobject(ApiCountryListReadDto)
data[].​isoCodestring
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
}

Order

Manage your Orders

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

webhook-controller

Operations

api-ecommerce-controller

Operations