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

Get Vat/Surcharge

Request

Get a specific vat/surcharge.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatTypeobject(ApiCustomerVatTypeListReadDto)required

Customer VAT type information

customerVatType.​idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatType.​codestringrequired

VAT type code. Example: GENERAL, REDUCED, EXEMPT, etc.

Example: "GENERAL"
customerVatType.​descriptionstring

Description of the VAT type.

Example: "General VAT type"
articleVatTypeobject(ApiArticleVatTypeListReadDto)required

Article VAT type information

articleVatType.​idinteger(int32)

Unique identifier of the VAT type

Example: 1
articleVatType.​codestring

Code for the VAT type

Example: "GENERAL"
articleVatType.​descriptionstring

Description of the VAT type

Example: "General VAT type"
vatPercentagenumber

VAT percentage applied

Example: 21
rePercentagenumber

Surcharge (Recargo de Equivalencia) percentage

Example: 5.2
sellVatAccountobject(ApiChartAccountListReadDto)

VAT account information for sales operations

sellRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for sales operations

buyVatAccountobject(ApiChartAccountListReadDto)

VAT account information for purchase operations

buyRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

Response
application/json
{
  "id": 1,
  "customerVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "articleVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "vatPercentage": 21,
  "rePercentage": 5.2,
  "sellVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "sellRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  }
}

Update Vat/Surcharge

Request

Update a specific vat/surcharge.

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

Customer VAT type identifier

Example: 1
articleVatTypestring(ApiArticleVatTypeEnum)required

Article VAT type classification

Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
vatPercentagenumber

VAT percentage to be applied

Example: 21
rePercentagenumber

Surcharge (Recargo de Equivalencia) percentage

Example: 5.2
sellVatAccountinteger(int32)

VAT account identifier for sales operations

Example: 4770000
sellRechargeAccountinteger(int32)

Surcharge account identifier for sales operations

Example: 4771000
buyVatAccountinteger(int32)

VAT account identifier for purchase operations

Example: 4720000
buyRechargeAccountinteger(int32)

Surcharge account identifier for purchase operations

Example: 4721000
curl -i -X PUT \
  'https://api.prana.software/api/v1/vat-type/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerVatType": 1,
    "articleVatType": "STANDARD",
    "vatPercentage": 21,
    "rePercentage": 5.2,
    "sellVatAccount": 4770000,
    "sellRechargeAccount": 4771000,
    "buyVatAccount": 4720000,
    "buyRechargeAccount": 4721000
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatTypeobject(ApiCustomerVatTypeListReadDto)required

Customer VAT type information

customerVatType.​idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatType.​codestringrequired

VAT type code. Example: GENERAL, REDUCED, EXEMPT, etc.

Example: "GENERAL"
customerVatType.​descriptionstring

Description of the VAT type.

Example: "General VAT type"
articleVatTypeobject(ApiArticleVatTypeListReadDto)required

Article VAT type information

articleVatType.​idinteger(int32)

Unique identifier of the VAT type

Example: 1
articleVatType.​codestring

Code for the VAT type

Example: "GENERAL"
articleVatType.​descriptionstring

Description of the VAT type

Example: "General VAT type"
vatPercentagenumber

VAT percentage applied

Example: 21
rePercentagenumber

Surcharge (Recargo de Equivalencia) percentage

Example: 5.2
sellVatAccountobject(ApiChartAccountListReadDto)

VAT account information for sales operations

sellRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for sales operations

buyVatAccountobject(ApiChartAccountListReadDto)

VAT account information for purchase operations

buyRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

Response
application/json
{
  "id": 1,
  "customerVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "articleVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "vatPercentage": 21,
  "rePercentage": 5.2,
  "sellVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "sellRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  }
}

Delete Vat/surcharge

Request

Delete specific vat/surcharge.

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

Responses

OK

Patch Vat/surcharge

Request

Patch specific Vat/surcharge.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatTypeobject(ApiCustomerVatTypeListReadDto)required

Customer VAT type information

customerVatType.​idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatType.​codestringrequired

VAT type code. Example: GENERAL, REDUCED, EXEMPT, etc.

Example: "GENERAL"
customerVatType.​descriptionstring

Description of the VAT type.

Example: "General VAT type"
articleVatTypeobject(ApiArticleVatTypeListReadDto)required

Article VAT type information

articleVatType.​idinteger(int32)

Unique identifier of the VAT type

Example: 1
articleVatType.​codestring

Code for the VAT type

Example: "GENERAL"
articleVatType.​descriptionstring

Description of the VAT type

Example: "General VAT type"
vatPercentagenumber

VAT percentage applied

Example: 21
rePercentagenumber

Surcharge (Recargo de Equivalencia) percentage

Example: 5.2
sellVatAccountobject(ApiChartAccountListReadDto)

VAT account information for sales operations

sellRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for sales operations

buyVatAccountobject(ApiChartAccountListReadDto)

VAT account information for purchase operations

buyRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

Response
application/json
{
  "id": 1,
  "customerVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "articleVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "vatPercentage": 21,
  "rePercentage": 5.2,
  "sellVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "sellRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  }
}

Create Vat/Surcharge

Request

Create a new vat/surcharge.

Bodyapplication/jsonrequired
customerVatTypeinteger(int32)required

Customer VAT type identifier

Example: 1
articleVatTypestring(ApiArticleVatTypeEnum)required

Article VAT type classification

Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
vatPercentagenumber

VAT percentage to be applied

Example: 21
rePercentagenumber

Surcharge (Recargo de Equivalencia) percentage

Example: 5.2
sellVatAccountinteger(int32)

VAT account identifier for sales operations

Example: 4770000
sellRechargeAccountinteger(int32)

Surcharge account identifier for sales operations

Example: 4771000
buyVatAccountinteger(int32)

VAT account identifier for purchase operations

Example: 4720000
buyRechargeAccountinteger(int32)

Surcharge account identifier for purchase operations

Example: 4721000
curl -i -X POST \
  https://api.prana.software/api/v1/vat-type \
  -H 'Content-Type: application/json' \
  -d '{
    "customerVatType": 1,
    "articleVatType": "STANDARD",
    "vatPercentage": 21,
    "rePercentage": 5.2,
    "sellVatAccount": 4770000,
    "sellRechargeAccount": 4771000,
    "buyVatAccount": 4720000,
    "buyRechargeAccount": 4721000
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatTypeobject(ApiCustomerVatTypeListReadDto)required

Customer VAT type information

customerVatType.​idinteger(int32)required

Unique identifier of the entity

Example: 1
customerVatType.​codestringrequired

VAT type code. Example: GENERAL, REDUCED, EXEMPT, etc.

Example: "GENERAL"
customerVatType.​descriptionstring

Description of the VAT type.

Example: "General VAT type"
articleVatTypeobject(ApiArticleVatTypeListReadDto)required

Article VAT type information

articleVatType.​idinteger(int32)

Unique identifier of the VAT type

Example: 1
articleVatType.​codestring

Code for the VAT type

Example: "GENERAL"
articleVatType.​descriptionstring

Description of the VAT type

Example: "General VAT type"
vatPercentagenumber

VAT percentage applied

Example: 21
rePercentagenumber

Surcharge (Recargo de Equivalencia) percentage

Example: 5.2
sellVatAccountobject(ApiChartAccountListReadDto)

VAT account information for sales operations

sellRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for sales operations

buyVatAccountobject(ApiChartAccountListReadDto)

VAT account information for purchase operations

buyRechargeAccountobject(ApiChartAccountListReadDto)

Surcharge account information for purchase operations

Response
application/json
{
  "id": 1,
  "customerVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "articleVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "vatPercentage": 21,
  "rePercentage": 5.2,
  "sellVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "sellRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyVatAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "buyRechargeAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  }
}

List Vats/Surcharges

Request

Get all your vats/surcharges.

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/vat-type/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(ApiVatListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​customerVatTypeobject(ApiCustomerVatTypeListReadDto)required

Customer VAT type details. See ApiCustomerVatTypeListReadDto for details.

data[].​customerVatType.​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​customerVatType.​codestringrequired

VAT type code. Example: GENERAL, REDUCED, EXEMPT, etc.

Example: "GENERAL"
data[].​customerVatType.​descriptionstring

Description of the VAT type.

Example: "General VAT type"
data[].​articleVatTypeobject(ApiArticleVatTypeListReadDto)required

Article VAT type details. See ApiArticleVatTypeListReadDto for details.

data[].​articleVatType.​idinteger(int32)

Unique identifier of the VAT type

Example: 1
data[].​articleVatType.​codestring

Code for the VAT type

Example: "GENERAL"
data[].​articleVatType.​descriptionstring

Description of the VAT type

Example: "General VAT type"
data[].​vatPercentagenumber

VAT percentage applied to the transaction.

Example: 21
data[].​rePercentagenumber

Surcharge percentage applied in addition to VAT.

Example: 5.2
data[].​sellVatAccountstring

Account code used for sales VAT registration.

Example: 4770000000
data[].​sellRechargeAccountstring

Account code used for sales surcharge registration.

Example: 4771000000
data[].​buyVatAccountstring

Account code used for purchases VAT registration.

Example: 4720000000
data[].​buyRechargeAccountstring

Account code used for purchases surcharge registration.

Example: 4721000000
data[].​descriptionstring

Description of the VAT configuration.

Example: "Standard VAT 21%"
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
}

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

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