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
Languages
Servers
https://api.prana.software

Stock Regularization

Manage your Stock Regularizations

Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Get a specific country.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Country code (usually ISO numeric or custom).

Example: 724
languageobject(ApiLanguageListReadDto)

Official language object. See ApiLanguageListReadDto.java for structure.

currencyobject(ApiCurrencyListReadDto)

Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.

agencyobject(ApiAgencyListReadDto)

Associated agency information. See ApiAgencyListReadDto.java for structure.

geographicalLocationstring(ApiGeographicalLocationEnum)required

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

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
descriptionstringrequired

Country name or description.

Example: "Spain"
prefixstring

Phone prefix of the country.

Example: "+34"
internationalCodestring

International country code.

Example: "ES"
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account for this country. See ApiChartAccountListReadDto.java for structure.

intrastatCodestring

Intrastat commodity code for international trade.

Example: 1000
intrastatUnitsstring

Unit of measurement for Intrastat declarations.

Example: "KG"
intrastatPercentagenumber

Percentage used for Intrastat reporting.

Example: 1.5
observationsstring

Additional observations or notes about the country.

Example: "Is a member of EU since 1986."
isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 country code.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
alpha3IsoCodestring(ApiAlpha3CountryCodeEnum)

ISO Alpha-3 country code.

Enum"AFG""ALA""ALB""DZA""ASM""AND""AGO""AIA""ATA""ATG"
Example: "ESP"
fdiCodestring

FDI country code.

Example: "ES"
sepaZoneboolean

True if country participates in SEPA zone.

Example: true
includeAddressInSepaboolean

If true, country address is included for SEPA operations.

Example: false
creditSuretystring

Credit surety information for the country.

Example: "Credit insurance with national provider"
languagesobject

Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type for this country. See ApiCustomerVatTypeListReadDto.java for structure.

Response
application/json
{ "id": 1, "code": 724, "language": { "id": 1, "code": "ES", "description": "Spanish", "isoCode": "EN" }, "currency": { "id": 1, "code": "strin", "description": "string", "nomenclature": "strin", "isoCode": "USD", "changeValue": 0, "significantDecimalsDocuments": 0, "intermediateDecimalsDocuments": 0, "decimalsCalculatePrices": 0, "decimalsCalculateCosts": 0 }, "agency": { "id": 1, "code": "AG001", "name": "Fast Transport Agency" }, "geographicalLocation": "NATIONAL", "description": "Spain", "prefix": "+34", "internationalCode": "ES", "accountingAccount": { "id": 1, "code": 1000, "description": "Cash account", "cif": "B12345678", "active": true, "color": "#FF5733", "parentCode": 100, "parentDescription": "Assets" }, "intrastatCode": 1000, "intrastatUnits": "KG", "intrastatPercentage": 1.5, "observations": "Is a member of EU since 1986.", "isoCode": "US", "alpha3IsoCode": "USA", "fdiCode": "ES", "sepaZone": true, "includeAddressInSepa": false, "creditSurety": "Credit insurance with national provider", "languages": { "property1": "string", "property2": "string" }, "customerVatType": { "id": 1, "code": "GENERAL", "description": "General VAT type" } }

Request

Update a specific country.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
codestring[ 0 .. 20 ] charactersrequired
languageinteger(int32)
currencyinteger(int32)
agencyinteger(int32)
geographicalLocationstring(ApiGeographicalLocationEnum)required

Defines the geographical locations.

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
descriptionstring[ 0 .. 100 ] charactersrequired
prefixstring
internationalCodestring
accountingAccountinteger(int32)
intrastatCodestring[ 0 .. 5 ] characters
intrastatUnitsstring[ 0 .. 10 ] characters
intrastatPercentagenumber
observationsstring
isoCodestring(ApiAlpha2CountryCodeEnum)

Defines the ISO Alpha-2 country codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
alpha3IsoCodestring(ApiAlpha3CountryCodeEnum)

Defines the ISO Alpha-3 country codes.

Enum"AFG""ALA""ALB""DZA""ASM""AND""AGO""AIA""ATA""ATG"
fdiCodestring(ApiFDICodesEnum)

Defines the FDI codes.

Enum"A""D""E""F""I""N""P"
sepaZoneboolean
includeAddressInSepaboolean
creditSuretystring[ 0 .. 5 ] characters
languagesobject
customerVatTypeinteger(int32)
curl -i -X PUT \
  'https://api.prana.software/api/v1/country/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "language": 0,
    "currency": 0,
    "agency": 0,
    "geographicalLocation": "NATIONAL",
    "description": "string",
    "prefix": "string",
    "internationalCode": "string",
    "accountingAccount": 0,
    "intrastatCode": "strin",
    "intrastatUnits": "string",
    "intrastatPercentage": 0,
    "observations": "string",
    "isoCode": "US",
    "alpha3IsoCode": "USA",
    "fdiCode": "A",
    "sepaZone": true,
    "includeAddressInSepa": true,
    "creditSurety": "strin",
    "languages": {
      "property1": "string",
      "property2": "string"
    },
    "customerVatType": 0
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Country code (usually ISO numeric or custom).

Example: 724
languageobject(ApiLanguageListReadDto)

Official language object. See ApiLanguageListReadDto.java for structure.

currencyobject(ApiCurrencyListReadDto)

Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.

agencyobject(ApiAgencyListReadDto)

Associated agency information. See ApiAgencyListReadDto.java for structure.

geographicalLocationstring(ApiGeographicalLocationEnum)required

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

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
descriptionstringrequired

Country name or description.

Example: "Spain"
prefixstring

Phone prefix of the country.

Example: "+34"
internationalCodestring

International country code.

Example: "ES"
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account for this country. See ApiChartAccountListReadDto.java for structure.

intrastatCodestring

Intrastat commodity code for international trade.

Example: 1000
intrastatUnitsstring

Unit of measurement for Intrastat declarations.

Example: "KG"
intrastatPercentagenumber

Percentage used for Intrastat reporting.

Example: 1.5
observationsstring

Additional observations or notes about the country.

Example: "Is a member of EU since 1986."
isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 country code.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
alpha3IsoCodestring(ApiAlpha3CountryCodeEnum)

ISO Alpha-3 country code.

Enum"AFG""ALA""ALB""DZA""ASM""AND""AGO""AIA""ATA""ATG"
Example: "ESP"
fdiCodestring

FDI country code.

Example: "ES"
sepaZoneboolean

True if country participates in SEPA zone.

Example: true
includeAddressInSepaboolean

If true, country address is included for SEPA operations.

Example: false
creditSuretystring

Credit surety information for the country.

Example: "Credit insurance with national provider"
languagesobject

Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type for this country. See ApiCustomerVatTypeListReadDto.java for structure.

Response
application/json
{ "id": 1, "code": 724, "language": { "id": 1, "code": "ES", "description": "Spanish", "isoCode": "EN" }, "currency": { "id": 1, "code": "strin", "description": "string", "nomenclature": "strin", "isoCode": "USD", "changeValue": 0, "significantDecimalsDocuments": 0, "intermediateDecimalsDocuments": 0, "decimalsCalculatePrices": 0, "decimalsCalculateCosts": 0 }, "agency": { "id": 1, "code": "AG001", "name": "Fast Transport Agency" }, "geographicalLocation": "NATIONAL", "description": "Spain", "prefix": "+34", "internationalCode": "ES", "accountingAccount": { "id": 1, "code": 1000, "description": "Cash account", "cif": "B12345678", "active": true, "color": "#FF5733", "parentCode": 100, "parentDescription": "Assets" }, "intrastatCode": 1000, "intrastatUnits": "KG", "intrastatPercentage": 1.5, "observations": "Is a member of EU since 1986.", "isoCode": "US", "alpha3IsoCode": "USA", "fdiCode": "ES", "sepaZone": true, "includeAddressInSepa": false, "creditSurety": "Credit insurance with national provider", "languages": { "property1": "string", "property2": "string" }, "customerVatType": { "id": 1, "code": "GENERAL", "description": "General VAT type" } }

Request

Delete specific country.

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

Responses

OK

Request

Patch specific Country.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Country code (usually ISO numeric or custom).

Example: 724
languageobject(ApiLanguageListReadDto)

Official language object. See ApiLanguageListReadDto.java for structure.

currencyobject(ApiCurrencyListReadDto)

Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.

agencyobject(ApiAgencyListReadDto)

Associated agency information. See ApiAgencyListReadDto.java for structure.

geographicalLocationstring(ApiGeographicalLocationEnum)required

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

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
descriptionstringrequired

Country name or description.

Example: "Spain"
prefixstring

Phone prefix of the country.

Example: "+34"
internationalCodestring

International country code.

Example: "ES"
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account for this country. See ApiChartAccountListReadDto.java for structure.

intrastatCodestring

Intrastat commodity code for international trade.

Example: 1000
intrastatUnitsstring

Unit of measurement for Intrastat declarations.

Example: "KG"
intrastatPercentagenumber

Percentage used for Intrastat reporting.

Example: 1.5
observationsstring

Additional observations or notes about the country.

Example: "Is a member of EU since 1986."
isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 country code.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
alpha3IsoCodestring(ApiAlpha3CountryCodeEnum)

ISO Alpha-3 country code.

Enum"AFG""ALA""ALB""DZA""ASM""AND""AGO""AIA""ATA""ATG"
Example: "ESP"
fdiCodestring

FDI country code.

Example: "ES"
sepaZoneboolean

True if country participates in SEPA zone.

Example: true
includeAddressInSepaboolean

If true, country address is included for SEPA operations.

Example: false
creditSuretystring

Credit surety information for the country.

Example: "Credit insurance with national provider"
languagesobject

Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type for this country. See ApiCustomerVatTypeListReadDto.java for structure.

Response
application/json
{ "id": 1, "code": 724, "language": { "id": 1, "code": "ES", "description": "Spanish", "isoCode": "EN" }, "currency": { "id": 1, "code": "strin", "description": "string", "nomenclature": "strin", "isoCode": "USD", "changeValue": 0, "significantDecimalsDocuments": 0, "intermediateDecimalsDocuments": 0, "decimalsCalculatePrices": 0, "decimalsCalculateCosts": 0 }, "agency": { "id": 1, "code": "AG001", "name": "Fast Transport Agency" }, "geographicalLocation": "NATIONAL", "description": "Spain", "prefix": "+34", "internationalCode": "ES", "accountingAccount": { "id": 1, "code": 1000, "description": "Cash account", "cif": "B12345678", "active": true, "color": "#FF5733", "parentCode": 100, "parentDescription": "Assets" }, "intrastatCode": 1000, "intrastatUnits": "KG", "intrastatPercentage": 1.5, "observations": "Is a member of EU since 1986.", "isoCode": "US", "alpha3IsoCode": "USA", "fdiCode": "ES", "sepaZone": true, "includeAddressInSepa": false, "creditSurety": "Credit insurance with national provider", "languages": { "property1": "string", "property2": "string" }, "customerVatType": { "id": 1, "code": "GENERAL", "description": "General VAT type" } }

Request

Create a new country.

Bodyapplication/jsonrequired
codestring[ 0 .. 20 ] charactersrequired
languageinteger(int32)
currencyinteger(int32)
agencyinteger(int32)
geographicalLocationstring(ApiGeographicalLocationEnum)required

Defines the geographical locations.

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
descriptionstring[ 0 .. 100 ] charactersrequired
prefixstring
internationalCodestring
accountingAccountinteger(int32)
intrastatCodestring[ 0 .. 5 ] characters
intrastatUnitsstring[ 0 .. 10 ] characters
intrastatPercentagenumber
observationsstring
isoCodestring(ApiAlpha2CountryCodeEnum)

Defines the ISO Alpha-2 country codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
alpha3IsoCodestring(ApiAlpha3CountryCodeEnum)

Defines the ISO Alpha-3 country codes.

Enum"AFG""ALA""ALB""DZA""ASM""AND""AGO""AIA""ATA""ATG"
fdiCodestring(ApiFDICodesEnum)

Defines the FDI codes.

Enum"A""D""E""F""I""N""P"
sepaZoneboolean
includeAddressInSepaboolean
creditSuretystring[ 0 .. 5 ] characters
languagesobject
customerVatTypeinteger(int32)
curl -i -X POST \
  https://api.prana.software/api/v1/country \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "language": 0,
    "currency": 0,
    "agency": 0,
    "geographicalLocation": "NATIONAL",
    "description": "string",
    "prefix": "string",
    "internationalCode": "string",
    "accountingAccount": 0,
    "intrastatCode": "strin",
    "intrastatUnits": "string",
    "intrastatPercentage": 0,
    "observations": "string",
    "isoCode": "US",
    "alpha3IsoCode": "USA",
    "fdiCode": "A",
    "sepaZone": true,
    "includeAddressInSepa": true,
    "creditSurety": "strin",
    "languages": {
      "property1": "string",
      "property2": "string"
    },
    "customerVatType": 0
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Country code (usually ISO numeric or custom).

Example: 724
languageobject(ApiLanguageListReadDto)

Official language object. See ApiLanguageListReadDto.java for structure.

currencyobject(ApiCurrencyListReadDto)

Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.

agencyobject(ApiAgencyListReadDto)

Associated agency information. See ApiAgencyListReadDto.java for structure.

geographicalLocationstring(ApiGeographicalLocationEnum)required

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

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
descriptionstringrequired

Country name or description.

Example: "Spain"
prefixstring

Phone prefix of the country.

Example: "+34"
internationalCodestring

International country code.

Example: "ES"
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account for this country. See ApiChartAccountListReadDto.java for structure.

intrastatCodestring

Intrastat commodity code for international trade.

Example: 1000
intrastatUnitsstring

Unit of measurement for Intrastat declarations.

Example: "KG"
intrastatPercentagenumber

Percentage used for Intrastat reporting.

Example: 1.5
observationsstring

Additional observations or notes about the country.

Example: "Is a member of EU since 1986."
isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 country code.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example: "ES"
alpha3IsoCodestring(ApiAlpha3CountryCodeEnum)

ISO Alpha-3 country code.

Enum"AFG""ALA""ALB""DZA""ASM""AND""AGO""AIA""ATA""ATG"
Example: "ESP"
fdiCodestring

FDI country code.

Example: "ES"
sepaZoneboolean

True if country participates in SEPA zone.

Example: true
includeAddressInSepaboolean

If true, country address is included for SEPA operations.

Example: false
creditSuretystring

Credit surety information for the country.

Example: "Credit insurance with national provider"
languagesobject

Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type for this country. See ApiCustomerVatTypeListReadDto.java for structure.

Response
application/json
{ "id": 1, "code": 724, "language": { "id": 1, "code": "ES", "description": "Spanish", "isoCode": "EN" }, "currency": { "id": 1, "code": "strin", "description": "string", "nomenclature": "strin", "isoCode": "USD", "changeValue": 0, "significantDecimalsDocuments": 0, "intermediateDecimalsDocuments": 0, "decimalsCalculatePrices": 0, "decimalsCalculateCosts": 0 }, "agency": { "id": 1, "code": "AG001", "name": "Fast Transport Agency" }, "geographicalLocation": "NATIONAL", "description": "Spain", "prefix": "+34", "internationalCode": "ES", "accountingAccount": { "id": 1, "code": 1000, "description": "Cash account", "cif": "B12345678", "active": true, "color": "#FF5733", "parentCode": 100, "parentDescription": "Assets" }, "intrastatCode": 1000, "intrastatUnits": "KG", "intrastatPercentage": 1.5, "observations": "Is a member of EU since 1986.", "isoCode": "US", "alpha3IsoCode": "USA", "fdiCode": "ES", "sepaZone": true, "includeAddressInSepa": false, "creditSurety": "Credit insurance with national provider", "languages": { "property1": "string", "property2": "string" }, "customerVatType": { "id": 1, "code": "GENERAL", "description": "General VAT type" } }

Request

Get all your countries.

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/country/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(ApiCountryListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​codestringrequired

Country code (usually ISO numeric or similar).

Example: 724
data[].​descriptionstringrequired

Country description or name.

Example: "Spain"
data[].​isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 code for the country.

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

Type of VAT scheme for customers in this country.

Example: "GENERAL"
data[].​geographicalLocationstring(ApiGeographicalLocationEnum)required

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

Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example: "EUROPE"
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 }
Operations

Stock Transfer

Manage your Stock Transfers

Operations
Operations

Warehouse Movement

Manage your warehouse movements

Operations
Operations
Operations

DeliveryNote

Manage your DeliveryNotes

Operations

Warehouse Accumulate

Manage your warehouse accumulates

Operations
Operations
Operations

Entity Last Update

Manage the last-updated timestamps for entities

Operations

Period

Retrieves the available accounting periods in the app

Operations
Operations
Operations

Purchase Invoice

Manage your Purchase Invoices

Operations
Operations
Operations

Payment Method

Manage your Payment Methods

Operations
Operations

Recurring Billing Templates

Manage your recurring billing templates

Operations
Operations

Billing Series

Manage your Billing Series

Operations
Operations
Operations

PurchaseDeliveryNote

Manage your PurchaseDeliveryNotes

Operations
Operations
Operations