Manage your Stock Regularizations
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
- https://api.prana.software/api/v1/country/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.prana.software/api/v1/country/{id}'OK
Official language object. See ApiLanguageListReadDto.java for structure.
Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.
Associated agency information. See ApiAgencyListReadDto.java for structure.
Geographical location of the country. See ApiGeographicalLocation enum for possible values.
Accounting account for this country. See ApiChartAccountListReadDto.java for structure.
Additional observations or notes about the country.
ISO Alpha-2 country code.
ISO Alpha-3 country code.
Credit surety information for the country.
Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}
{ "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" } }
Defines the geographical locations.
Defines the ISO Alpha-2 country codes.
Defines the ISO Alpha-3 country codes.
- https://api.prana.software/api/v1/country/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'OK
Official language object. See ApiLanguageListReadDto.java for structure.
Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.
Associated agency information. See ApiAgencyListReadDto.java for structure.
Geographical location of the country. See ApiGeographicalLocation enum for possible values.
Accounting account for this country. See ApiChartAccountListReadDto.java for structure.
Additional observations or notes about the country.
ISO Alpha-2 country code.
ISO Alpha-3 country code.
Credit surety information for the country.
Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}
{ "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" } }
- https://api.prana.software/api/v1/country/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api.prana.software/api/v1/country/{id}' \
-H 'Content-Type: application/json' \
-d '{
"property1": {},
"property2": {}
}'OK
Official language object. See ApiLanguageListReadDto.java for structure.
Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.
Associated agency information. See ApiAgencyListReadDto.java for structure.
Geographical location of the country. See ApiGeographicalLocation enum for possible values.
Accounting account for this country. See ApiChartAccountListReadDto.java for structure.
Additional observations or notes about the country.
ISO Alpha-2 country code.
ISO Alpha-3 country code.
Credit surety information for the country.
Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}
{ "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" } }
Defines the geographical locations.
Defines the ISO Alpha-2 country codes.
Defines the ISO Alpha-3 country codes.
- https://api.prana.software/api/v1/country
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'OK
Official language object. See ApiLanguageListReadDto.java for structure.
Reference currency object for this country. See ApiCurrencyListReadDto.java for structure.
Associated agency information. See ApiAgencyListReadDto.java for structure.
Geographical location of the country. See ApiGeographicalLocation enum for possible values.
Accounting account for this country. See ApiChartAccountListReadDto.java for structure.
Additional observations or notes about the country.
ISO Alpha-2 country code.
ISO Alpha-3 country code.
Credit surety information for the country.
Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}
{ "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" } }
- https://api.prana.software/api/v1/country/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'{ "data": [ { … } ], "page": 0, "total": 150, "pages": 14, "size": 10 }