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

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

Get Company

Request

Get a specific company.

curl -i -X GET \
  https://api.prana.software/api/v1/company

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
namestring

Company name.

Example: "CLAVEi"
cifstring

Company tax identification code.

Example: "B12345678"
emailAddressstring

Main company email address.

Example: "info@clavei.es"
emailHoststring

SMTP email host.

Example: "smtp.clavei.es"
emailPortinteger(int32)

SMTP email server port.

Example: 587
emailUsernamestring

SMTP username for outgoing email.

Example: "user@clavei.es"
emailPasswordKeystring

Encrypted key for the email password.

Example: "ENCRYPTED_KEY_123"
emailReplyToAddressstring

Reply-to email address used in communications.

Example: "support@clavei.es"
emailSignaturestring

Email signature in HTML or plain text.

emailEnableTlsboolean

If true, TLS is enabled for outgoing emails.

Example: true
createdBystring

User who created the record.

Example: "admin"
modifiedBystring

User who last modified the record.

Example: "johndoe"
createdOnstring(date-time)

Timestamp when the record was created. Format: yyyy-MM-dd'T'HH:mm:ss

Example: "2024-01-03T08:15:45"
modifiedOnstring(date-time)

Timestamp when the record was last modified. Format: yyyy-MM-dd'T'HH:mm:ss

Example: "2024-08-07T17:35:00"
additionalInfoobject(ApiCompanyInfoReadDto)

Additional information of the company. See ApiCompanyInfoReadDto.java for structure.

posModuleActiveboolean

Indicates if the POS module is active for the company.

Example: true
posModuleTrialboolean

Indicates if the POS module is in trial mode for the company.

Example: false
Response
application/json
{
  "id": 1,
  "name": "CLAVEi",
  "cif": "B12345678",
  "emailAddress": "info@clavei.es",
  "emailHost": "smtp.clavei.es",
  "emailPort": 587,
  "emailUsername": "user@clavei.es",
  "emailPasswordKey": "ENCRYPTED_KEY_123",
  "emailReplyToAddress": "support@clavei.es",
  "emailSignature": "string",
  "emailEnableTls": true,
  "createdBy": "admin",
  "modifiedBy": "johndoe",
  "createdOn": "2024-01-03T08:15:45",
  "modifiedOn": "2024-08-07T17:35:00",
  "additionalInfo": {
    "id": 1,
    "code": "C100",
    "commercialName": "Clavei",
    "cif": "B12345678",
    "name": "Clavei S.L.",
    "address": "Avda. Salamanca 7",
    "country": { … },
    "state": { … },
    "postalCode": "03203",
    "city": "Elche",
    "phone1": "+34 966 610 442",
    "phone2": "+34 966 610 443",
    "email": "info@clavei.es",
    "website": "https://www.clavei.es",
    "commercialRegistry": "Volume 1234, Sheet 56, Inscription 1",
    "observations": "Leading software provider in Alicante",
    "logo": "logo.png",
    "logoToken": "token-1a2b3c",
    "activeB2B": true,
    "backgroundImage": "background.jpg",
    "backgroundImageToken": "token-bg",
    "blockchainAccount": "0x342acbd88491ca",
    "blockchainPrivateKey": "PRIVKEY123",
    "ropoCode": "ROPOCODE456",
    "customerVatType": { … },
    "paymentMethod": { … },
    "unitType": { … },
    "warehouse": { … },
    "rateCode": { … },
    "salesAccount": { … },
    "purchasingAccount": { … },
    "bank": { … },
    "billingSeriesSale": { … },
    "billingSeriesSaleTicket": { … },
    "billingSeriesPurchase": { … },
    "billingSeriesPurchaseTicket": { … },
    "billingSeriesInvoiceDraft": { … },
    "currency": { … },
    "shippingTerm": { … },
    "secondaryCurrency": { … },
    "customersAccount": { … },
    "suppliersAccount": { … },
    "creditorVatAccount": { … },
    "debtorVatAccount": { … },
    "supInternalOpAccount": { … },
    "supRecAccount": { … },
    "supAssetsAccount": { … },
    "supServicesAccount": { … },
    "supImportsAccount": { … },
    "supIrpfLeasesAccount": { … },
    "supIrpfProfessionalAccount": { … },
    "supIrpfAgroAccount": { … },
    "outInternalOpAccount": { … },
    "outRecAccount": { … },
    "outAssetsAccount": { … },
    "outServicesAccount": { … },
    "outImportsAccount": { … },
    "outReverseChargeAccount": { … },
    "outWithholdingAccount": { … },
    "salesConcept": { … },
    "purchasingConcept": { … },
    "igic": false,
    "companyType": "LEGAL_PERSON",
    "ticketbaiTaxAuthority": "ALAVA",
    "underEquivalenceSurchargeRegime": true,
    "numericFormatStyle": "US_WITH_GROUPING",
    "ticketbaiActive": true,
    "ticketbaiConditionDate": "2025-01-01",
    "ticketbaiConditionName": "Clavei S.L.",
    "ticketbaiConditionVatId": "B12345678",
    "ticketbaiConditionAddress": "Avda. Salamanca 7, Elche",
    "defaultInvoiceDescription": "Software development services",
    "ticketbaiTest": false,
    "vatOperationType": { … },
    "verifactuActive": true,
    "verifactuTest": false,
    "verifactuStartDate": "2025-06-01",
    "verifactuEndDate": "2025-12-31",
    "receiptConcept": { … },
    "purchaseReceiptConcept": { … },
    "modeVerifactu": false,
    "verifactuExemptCause": "SII",
    "verifactuExemptDate": "2025-07-01",
    "openingConcept": { … },
    "closingConcept": { … },
    "operatingClosingConcept": { … }
  },
  "posModuleActive": true,
  "posModuleTrial": false
}

PurchaseDeliveryNote

Manage your PurchaseDeliveryNotes

Operations

webhook-controller

Operations

api-ecommerce-controller

Operations