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

PurchaseDeliveryNote

Manage your PurchaseDeliveryNotes

Operations

Get PurchaseDeliveryNote

Request

Get a specific purchaseDeliveryNote.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
numberintegerrequired

Unique serial number of the document header.

Example: 1001
documentDatestring(date)required

Date of the document in ISO format (yyyy-MM-dd).

Example: "2024-08-07"
quantityTotalnumber

Total quantity for all document lines.

Example: 200.5
observationsstring

Free text field for any observations related to the document.

Example: "Customer requested urgent delivery"
linesArray of objects(ApiPurchaseDeliveryNoteLineReadDto)

List of detail lines for the document. For structure see: ApiBaseLineReadDto.java

changenumber

Change applied to the invoice or document

Example: 0.5
discount1number

First discount percentage

Example: 5
discount2number

Second discount percentage

Example: 2
discountAmountTotalnumber

Total discount amount

Example: 100
discountAmountTotalCompanyCurrencynumber

Total discount amount in company currency

Example: 95
discountPpnumber

Prompt payment discount percentage

Example: 3
discountPpAmountTotalnumber

Total prompt payment discount amount

Example: 15
discountPpAmountTotalCompanyCurrencynumber

Total prompt payment discount amount in company currency

Example: 14
grossAmountTotalnumber

Gross total amount

Example: 1200
grossAmountTotalCompanyCurrencynumber

Gross total amount in company currency

Example: 1150
netAmountTotalnumber

Net total amount

Example: 1100
netAmountTotalCompanyCurrencynumber

Net total amount in company currency

Example: 1080
vatAmountTotalnumber

Total VAT amount

Example: 230
vatAmountTotalCompanyCurrencynumber

Total VAT amount in company currency

Example: 225
surchargeAmountTotalnumber

Total surcharge amount

Example: 20
surchargeAmountTotalCompanyCurrencynumber

Total surcharge amount in company currency

Example: 18
withholdingnumber

Withholding percentage

Example: 2
withholdingAmountTotalnumber

Total withholding amount

Example: 22
withholdingAmountTotalCompanyCurrencynumber

Total withholding amount in company currency

Example: 21
totalnumber

Total document amount

Example: 1300
totalCompanyCurrencynumber

Total document amount in company currency

Example: 1280
disbursementAmountTotalnumber

Total disbursement amount

Example: 50
disbursementAmountTotalCompanyCurrencynumber

Total disbursement amount in company currency

Example: 48
billingSeriesobject(ApiBillingSeriesListReadDto)

Billing series information

receivedDatestring(date)

Date when the delivery note was received

Example: "2024-08-07"
billCodestring

Bill code reference

Example: "BILL-2024-001"
lockedboolean

Indicates if the delivery note is locked for modifications

Example: false
warehouseobject(ApiWarehouseListReadDto)

Warehouse information

referencestring

Reference number for the delivery note

Example: "DN-2024-001"
noAccumulateWarehouseboolean

Indicates if warehouse accumulation is disabled

Example: false
supplierobject(ApiSupplierListReadDto)

Supplier information

supplierNamestring

Name of the supplier

Example: "ABC Suppliers Ltd."
supplierAddressstring

Address of the supplier

Example: 123
supplierPhonestring

Phone number of the supplier

Example: "+34 91 123 4567"
supplierEmailstring

Email address of the supplier

Example: "contact@abcsuppliers.com"
supplierCifstring

Tax identification number of the supplier

Example: "B12345678"
deliveryNotestring

Delivery note reference

Example: "DN-SUPP-2024-001"
packagesinteger(int32)

Total number of packages

Example: 5
billingObservationsstring

Billing observations

Example: "Handle with care"
paymentMethodobject(ApiPaymentMethodListReadDto)

DTO para listar los métodos de pago disponibles

firstTerminteger(int32)

First payment term in days

Example: 30
daysTerminteger(int32)

Subsequent payment term in days

Example: 30
termsinteger(int32)

Number of payment terms

Example: 3
proximityTypestring(ApiProximityTypeEnum)

Type of proximity for the delivery

Enum"NEARBY""PREVIOUS""LATER"
Example: "LOCAL"
currencyobject(ApiCurrencyListReadDto)

Currency information

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type information

shippingTermobject(ApiShippingTermListReadDto)

Shipping terms information

shippingVatTypestring(ApiArticleVatTypeEnum)

VAT type for shipping costs

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

VAT percentage applied to shipping

Example: 21
shippingSurchargePercentagenumber

Surcharge percentage applied to shipping

Example: 5.2
invoiceDocumentDatestring(date)

Document date of the related invoice

Example: "2024-08-05"
invoiceBillingSeriesCodestring

Billing series code of the related invoice

Example: "A"
tagsArray of strings

Tags associated with the delivery note

Example: ["urgent","priority"]
invoiceEditObservationsstring

Invoice editing observations

Example: "Invoice reviewed and approved"
Response
application/json
{
  "id": 1,
  "number": 1001,
  "documentDate": "2024-08-07",
  "quantityTotal": 200.5,
  "observations": "Customer requested urgent delivery",
  "lines": [
    { … }
  ],
  "change": 0.5,
  "discount1": 5,
  "discount2": 2,
  "discountAmountTotal": 100,
  "discountAmountTotalCompanyCurrency": 95,
  "discountPp": 3,
  "discountPpAmountTotal": 15,
  "discountPpAmountTotalCompanyCurrency": 14,
  "grossAmountTotal": 1200,
  "grossAmountTotalCompanyCurrency": 1150,
  "netAmountTotal": 1100,
  "netAmountTotalCompanyCurrency": 1080,
  "vatAmountTotal": 230,
  "vatAmountTotalCompanyCurrency": 225,
  "surchargeAmountTotal": 20,
  "surchargeAmountTotalCompanyCurrency": 18,
  "withholding": 2,
  "withholdingAmountTotal": 22,
  "withholdingAmountTotalCompanyCurrency": 21,
  "total": 1300,
  "totalCompanyCurrency": 1280,
  "disbursementAmountTotal": 50,
  "disbursementAmountTotalCompanyCurrency": 48,
  "billingSeries": {
    "id": 1,
    "type": "SALE",
    "code": "SER2025",
    "description": "Main invoice series",
    "deposit": true,
    "corrective": false,
    "otherSIF": false
  },
  "receivedDate": "2024-08-07",
  "billCode": "BILL-2024-001",
  "locked": false,
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse",
    "population": "Madrid",
    "active": true
  },
  "reference": "DN-2024-001",
  "noAccumulateWarehouse": false,
  "supplier": {
    "id": 1,
    "code": 20001,
    "cif": "B87654321",
    "commercialName": "Supplier Corp",
    "name": "Supplier Corporation S.L.",
    "address": "Calle Mayor, 10",
    "country": "ES",
    "state": "MAD",
    "postalCode": 28001,
    "city": "Madrid",
    "phone1": "+34911222333",
    "phone2": "+34911444555",
    "currency": "EUR",
    "currencyNomenclature": "Euro",
    "currencyChangeValue": 1,
    "active": true,
    "email": "contact@suppliercorp.com",
    "shippingTerm": 15,
    "tags": [ … ],
    "vatDescription": "IVA General 21%",
    "discount1": 3.5,
    "paymentMethodId": 3,
    "paymentMethod": "Bank Transfer",
    "currencyCode": "EUR",
    "creationDate": "2021-03-15",
    "inactiveDate": "2024-10-01",
    "countryDescription": "España",
    "stateDescription": "Madrid",
    "bankName": "BBVA",
    "account": "ES7921000813610123456789",
    "picture": "https://www.suppliercorp.com/logo.png",
    "pictureToken": "a1b2c3d4e5f6",
    "modifiedOn": "2024-12-10T14:30:00+01:00",
    "web": "https://www.suppliercorp.com"
  },
  "supplierName": "ABC Suppliers Ltd.",
  "supplierAddress": 123,
  "supplierPhone": "+34 91 123 4567",
  "supplierEmail": "contact@abcsuppliers.com",
  "supplierCif": "B12345678",
  "deliveryNote": "DN-SUPP-2024-001",
  "packages": 5,
  "billingObservations": "Handle with care",
  "paymentMethod": {
    "id": 1,
    "code": 1,
    "description": "Transferencia bancaria",
    "document": "Contrato",
    "firstTerm": 30,
    "terms": 3,
    "daysTerms": 30,
    "remittance": true,
    "addToCustomerBase": true,
    "serveFullPrePaid": false,
    "observations": "Requiere verificación bancaria",
    "icon": "fa-credit-card",
    "facturaECode": "01"
  },
  "firstTerm": 30,
  "daysTerm": 30,
  "terms": 3,
  "proximityType": "NEARBY",
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "customerVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "shippingTerm": {
    "id": 1,
    "code": "string",
    "customerPays": true,
    "intrastatCode": "string"
  },
  "shippingVatType": "STANDARD",
  "shippingVatPercentage": 21,
  "shippingSurchargePercentage": 5.2,
  "invoiceDocumentDate": "2024-08-05",
  "invoiceBillingSeriesCode": "A",
  "tags": [
    "urgent",
    "priority"
  ],
  "invoiceEditObservations": "Invoice reviewed and approved"
}

Update PurchaseDeliveryNote

Request

Update a specific purchaseDeliveryNote.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
numberinteger

Unique serial number of the document header.

Example: 1050
documentDatestring(date)

Date of the document in ISO format (yyyy-MM-dd).

Example: "2025-08-07"
quantityTotalnumber

Total quantity of all document lines.

Example: 120.5
observationsstring

Free text for header observations.

Example: "Deliver to warehouse B"
linesArray of objects(ApiPurchaseDeliveryNoteLineWriteDto)

List of document lines. For structure, see ApiBaseLineWriteDto.java

idinteger(int32)

Unique identifier of the purchase delivery note

Example: 1001
billingSeriesinteger(int32)required

Billing series identifier

Example: 5
receivedDatestring(date)required

Date when the delivery note was received

Example: "2024-08-07"
billCodestring[ 0 .. 50 ] characters

Bill code reference

Example: "BILL-2024-001"
lockedboolean

Indicates if the delivery note is locked for modifications

Example: false
warehouseinteger(int32)required

Warehouse identifier

Example: 3
referencestring[ 0 .. 50 ] characters

Reference number for the delivery note

Example: "DN-2024-001"
noAccumulateWarehouseboolean

Indicates if warehouse accumulation is disabled

Example: false
supplierinteger(int32)required

Supplier identifier

Example: 1001
deliveryNotestring[ 0 .. 20 ] characters

Delivery note reference

Example: "DN-SUPP-2024-001"
packagesinteger(int32)

Total number of packages

Example: 5
billingObservationsstring[ 0 .. 255 ] characters

Billing observations

Example: "Handle with care"
paymentMethodinteger(int32)

Payment method identifier

Example: 3
firstTerminteger(int32)

First payment term in days

Example: 30
daysTerminteger(int32)

Subsequent payment term in days

Example: 30
termsinteger(int32)

Number of payment terms

Example: 3
proximityTypestring(ApiProximityTypeEnum)

Type of proximity for the delivery

Enum"NEARBY""PREVIOUS""LATER"
Example: "LOCAL"
withholdinginteger(int32)

Withholding identifier

Example: 1
discount1number

First discount percentage

Example: 10
discount2number

Second discount percentage

Example: 5
discountPpnumber

Prompt payment discount percentage

Example: 3
currencyinteger(int32)required

Currency identifier

Example: 1
changenumber

Exchange rate for currency conversion

Example: 1
customerVatTypeinteger(int32)

Customer VAT type identifier

Example: 1
shippingVatTypestring(ApiArticleVatTypeEnum)

VAT type for shipping costs

Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
shippingTerminteger(int32)

Shipping term identifier

Example: 2
shippingVatPercentagenumber

VAT percentage applied to shipping

Example: 21
shippingSurchargePercentagenumber

Surcharge percentage applied to shipping

Example: 5.2
tagsArray of strings

Tags associated with the delivery note

Example: ["urgent","priority"]
invoiceEditObservationsstring

Invoice editing observations

Example: "Delivery note reviewed and approved"
purchasingAccountinteger(int32)

Purchasing account identifier

Example: 6000001
curl -i -X PUT \
  'https://api.prana.software/api/v1/purchaseDeliveryNote/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": 1050,
    "documentDate": "2025-08-07",
    "quantityTotal": 120.5,
    "observations": "Deliver to warehouse B",
    "lines": [
      {
        "id": 1001,
        "articleCombination": 5312,
        "sizeRange": 15,
        "assortment": 8,
        "lineNumber": 1,
        "articleDescription": "Cotton T-shirt - Blue",
        "packages": 3,
        "quantityPerPackage": 12,
        "price": 19.99,
        "lineObservations": "Special discount applied.",
        "details": [
          {
            "id": 200,
            "sizeRangeDetail": 15,
            "width": 12,
            "quantityPerPackage": 9.3
          }
        ],
        "packaging": 1001,
        "discount": 10.5,
        "vatPercentage": 21,
        "reference": "REF-2024-001",
        "picture": "product_image_001.jpg",
        "noAccumulateWarehouse": false,
        "warehouse": 3,
        "assortedPackages": true,
        "shippingVatType": "STANDARD",
        "shippingVatPercentage": 21,
        "shippingSurchargePercentage": 5.2,
        "articleVatType": "STANDARD",
        "surchargePercentage": 5.2,
        "grossAmount": 1000,
        "grossAmountCompanyCurrency": 1000,
        "netAmount": 900,
        "netAmountCompanyCurrency": 900,
        "totalLine": 1089,
        "totalLineCompanyCurrency": 1089,
        "batchList": [
          {
            "id": 11,
            "batch": "LOT-2025B",
            "quantity": 75.5,
            "packages": 2
          }
        ],
        "serialNumberList": [
          {
            "id": 12,
            "serialNumber": "SN-20250807-XYZ"
          }
        ],
        "disbursement": false,
        "concept": "Product purchase"
      }
    ],
    "id": 1001,
    "billingSeries": 5,
    "receivedDate": "2024-08-07",
    "billCode": "BILL-2024-001",
    "locked": false,
    "warehouse": 3,
    "reference": "DN-2024-001",
    "noAccumulateWarehouse": false,
    "supplier": 1001,
    "deliveryNote": "DN-SUPP-2024-001",
    "packages": 5,
    "billingObservations": "Handle with care",
    "paymentMethod": 3,
    "firstTerm": 30,
    "daysTerm": 30,
    "terms": 3,
    "proximityType": "NEARBY",
    "withholding": 1,
    "discount1": 10,
    "discount2": 5,
    "discountPp": 3,
    "currency": 1,
    "change": 1,
    "customerVatType": 1,
    "shippingVatType": "STANDARD",
    "shippingTerm": 2,
    "shippingVatPercentage": 21,
    "shippingSurchargePercentage": 5.2,
    "tags": [
      "urgent",
      "priority"
    ],
    "invoiceEditObservations": "Delivery note reviewed and approved",
    "purchasingAccount": 6000001
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
numberintegerrequired

Unique serial number of the document header.

Example: 1001
documentDatestring(date)required

Date of the document in ISO format (yyyy-MM-dd).

Example: "2024-08-07"
quantityTotalnumber

Total quantity for all document lines.

Example: 200.5
observationsstring

Free text field for any observations related to the document.

Example: "Customer requested urgent delivery"
linesArray of objects(ApiPurchaseDeliveryNoteLineReadDto)

List of detail lines for the document. For structure see: ApiBaseLineReadDto.java

changenumber

Change applied to the invoice or document

Example: 0.5
discount1number

First discount percentage

Example: 5
discount2number

Second discount percentage

Example: 2
discountAmountTotalnumber

Total discount amount

Example: 100
discountAmountTotalCompanyCurrencynumber

Total discount amount in company currency

Example: 95
discountPpnumber

Prompt payment discount percentage

Example: 3
discountPpAmountTotalnumber

Total prompt payment discount amount

Example: 15
discountPpAmountTotalCompanyCurrencynumber

Total prompt payment discount amount in company currency

Example: 14
grossAmountTotalnumber

Gross total amount

Example: 1200
grossAmountTotalCompanyCurrencynumber

Gross total amount in company currency

Example: 1150
netAmountTotalnumber

Net total amount

Example: 1100
netAmountTotalCompanyCurrencynumber

Net total amount in company currency

Example: 1080
vatAmountTotalnumber

Total VAT amount

Example: 230
vatAmountTotalCompanyCurrencynumber

Total VAT amount in company currency

Example: 225
surchargeAmountTotalnumber

Total surcharge amount

Example: 20
surchargeAmountTotalCompanyCurrencynumber

Total surcharge amount in company currency

Example: 18
withholdingnumber

Withholding percentage

Example: 2
withholdingAmountTotalnumber

Total withholding amount

Example: 22
withholdingAmountTotalCompanyCurrencynumber

Total withholding amount in company currency

Example: 21
totalnumber

Total document amount

Example: 1300
totalCompanyCurrencynumber

Total document amount in company currency

Example: 1280
disbursementAmountTotalnumber

Total disbursement amount

Example: 50
disbursementAmountTotalCompanyCurrencynumber

Total disbursement amount in company currency

Example: 48
billingSeriesobject(ApiBillingSeriesListReadDto)

Billing series information

receivedDatestring(date)

Date when the delivery note was received

Example: "2024-08-07"
billCodestring

Bill code reference

Example: "BILL-2024-001"
lockedboolean

Indicates if the delivery note is locked for modifications

Example: false
warehouseobject(ApiWarehouseListReadDto)

Warehouse information

referencestring

Reference number for the delivery note

Example: "DN-2024-001"
noAccumulateWarehouseboolean

Indicates if warehouse accumulation is disabled

Example: false
supplierobject(ApiSupplierListReadDto)

Supplier information

supplierNamestring

Name of the supplier

Example: "ABC Suppliers Ltd."
supplierAddressstring

Address of the supplier

Example: 123
supplierPhonestring

Phone number of the supplier

Example: "+34 91 123 4567"
supplierEmailstring

Email address of the supplier

Example: "contact@abcsuppliers.com"
supplierCifstring

Tax identification number of the supplier

Example: "B12345678"
deliveryNotestring

Delivery note reference

Example: "DN-SUPP-2024-001"
packagesinteger(int32)

Total number of packages

Example: 5
billingObservationsstring

Billing observations

Example: "Handle with care"
paymentMethodobject(ApiPaymentMethodListReadDto)

DTO para listar los métodos de pago disponibles

firstTerminteger(int32)

First payment term in days

Example: 30
daysTerminteger(int32)

Subsequent payment term in days

Example: 30
termsinteger(int32)

Number of payment terms

Example: 3
proximityTypestring(ApiProximityTypeEnum)

Type of proximity for the delivery

Enum"NEARBY""PREVIOUS""LATER"
Example: "LOCAL"
currencyobject(ApiCurrencyListReadDto)

Currency information

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type information

shippingTermobject(ApiShippingTermListReadDto)

Shipping terms information

shippingVatTypestring(ApiArticleVatTypeEnum)

VAT type for shipping costs

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

VAT percentage applied to shipping

Example: 21
shippingSurchargePercentagenumber

Surcharge percentage applied to shipping

Example: 5.2
invoiceDocumentDatestring(date)

Document date of the related invoice

Example: "2024-08-05"
invoiceBillingSeriesCodestring

Billing series code of the related invoice

Example: "A"
tagsArray of strings

Tags associated with the delivery note

Example: ["urgent","priority"]
invoiceEditObservationsstring

Invoice editing observations

Example: "Invoice reviewed and approved"
Response
application/json
{
  "id": 1,
  "number": 1001,
  "documentDate": "2024-08-07",
  "quantityTotal": 200.5,
  "observations": "Customer requested urgent delivery",
  "lines": [
    { … }
  ],
  "change": 0.5,
  "discount1": 5,
  "discount2": 2,
  "discountAmountTotal": 100,
  "discountAmountTotalCompanyCurrency": 95,
  "discountPp": 3,
  "discountPpAmountTotal": 15,
  "discountPpAmountTotalCompanyCurrency": 14,
  "grossAmountTotal": 1200,
  "grossAmountTotalCompanyCurrency": 1150,
  "netAmountTotal": 1100,
  "netAmountTotalCompanyCurrency": 1080,
  "vatAmountTotal": 230,
  "vatAmountTotalCompanyCurrency": 225,
  "surchargeAmountTotal": 20,
  "surchargeAmountTotalCompanyCurrency": 18,
  "withholding": 2,
  "withholdingAmountTotal": 22,
  "withholdingAmountTotalCompanyCurrency": 21,
  "total": 1300,
  "totalCompanyCurrency": 1280,
  "disbursementAmountTotal": 50,
  "disbursementAmountTotalCompanyCurrency": 48,
  "billingSeries": {
    "id": 1,
    "type": "SALE",
    "code": "SER2025",
    "description": "Main invoice series",
    "deposit": true,
    "corrective": false,
    "otherSIF": false
  },
  "receivedDate": "2024-08-07",
  "billCode": "BILL-2024-001",
  "locked": false,
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse",
    "population": "Madrid",
    "active": true
  },
  "reference": "DN-2024-001",
  "noAccumulateWarehouse": false,
  "supplier": {
    "id": 1,
    "code": 20001,
    "cif": "B87654321",
    "commercialName": "Supplier Corp",
    "name": "Supplier Corporation S.L.",
    "address": "Calle Mayor, 10",
    "country": "ES",
    "state": "MAD",
    "postalCode": 28001,
    "city": "Madrid",
    "phone1": "+34911222333",
    "phone2": "+34911444555",
    "currency": "EUR",
    "currencyNomenclature": "Euro",
    "currencyChangeValue": 1,
    "active": true,
    "email": "contact@suppliercorp.com",
    "shippingTerm": 15,
    "tags": [ … ],
    "vatDescription": "IVA General 21%",
    "discount1": 3.5,
    "paymentMethodId": 3,
    "paymentMethod": "Bank Transfer",
    "currencyCode": "EUR",
    "creationDate": "2021-03-15",
    "inactiveDate": "2024-10-01",
    "countryDescription": "España",
    "stateDescription": "Madrid",
    "bankName": "BBVA",
    "account": "ES7921000813610123456789",
    "picture": "https://www.suppliercorp.com/logo.png",
    "pictureToken": "a1b2c3d4e5f6",
    "modifiedOn": "2024-12-10T14:30:00+01:00",
    "web": "https://www.suppliercorp.com"
  },
  "supplierName": "ABC Suppliers Ltd.",
  "supplierAddress": 123,
  "supplierPhone": "+34 91 123 4567",
  "supplierEmail": "contact@abcsuppliers.com",
  "supplierCif": "B12345678",
  "deliveryNote": "DN-SUPP-2024-001",
  "packages": 5,
  "billingObservations": "Handle with care",
  "paymentMethod": {
    "id": 1,
    "code": 1,
    "description": "Transferencia bancaria",
    "document": "Contrato",
    "firstTerm": 30,
    "terms": 3,
    "daysTerms": 30,
    "remittance": true,
    "addToCustomerBase": true,
    "serveFullPrePaid": false,
    "observations": "Requiere verificación bancaria",
    "icon": "fa-credit-card",
    "facturaECode": "01"
  },
  "firstTerm": 30,
  "daysTerm": 30,
  "terms": 3,
  "proximityType": "NEARBY",
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "customerVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "shippingTerm": {
    "id": 1,
    "code": "string",
    "customerPays": true,
    "intrastatCode": "string"
  },
  "shippingVatType": "STANDARD",
  "shippingVatPercentage": 21,
  "shippingSurchargePercentage": 5.2,
  "invoiceDocumentDate": "2024-08-05",
  "invoiceBillingSeriesCode": "A",
  "tags": [
    "urgent",
    "priority"
  ],
  "invoiceEditObservations": "Invoice reviewed and approved"
}

Delete PurchaseDeliveryNote

Request

Delete specific purchaseDeliveryNote.

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

Responses

OK

Create PurchaseDeliveryNote

Request

Create a new purchaseDeliveryNote.

Bodyapplication/jsonrequired
numberinteger

Unique serial number of the document header.

Example: 1050
documentDatestring(date)

Date of the document in ISO format (yyyy-MM-dd).

Example: "2025-08-07"
quantityTotalnumber

Total quantity of all document lines.

Example: 120.5
observationsstring

Free text for header observations.

Example: "Deliver to warehouse B"
linesArray of objects(ApiPurchaseDeliveryNoteLineWriteDto)

List of document lines. For structure, see ApiBaseLineWriteDto.java

idinteger(int32)

Unique identifier of the purchase delivery note

Example: 1001
billingSeriesinteger(int32)required

Billing series identifier

Example: 5
receivedDatestring(date)required

Date when the delivery note was received

Example: "2024-08-07"
billCodestring[ 0 .. 50 ] characters

Bill code reference

Example: "BILL-2024-001"
lockedboolean

Indicates if the delivery note is locked for modifications

Example: false
warehouseinteger(int32)required

Warehouse identifier

Example: 3
referencestring[ 0 .. 50 ] characters

Reference number for the delivery note

Example: "DN-2024-001"
noAccumulateWarehouseboolean

Indicates if warehouse accumulation is disabled

Example: false
supplierinteger(int32)required

Supplier identifier

Example: 1001
deliveryNotestring[ 0 .. 20 ] characters

Delivery note reference

Example: "DN-SUPP-2024-001"
packagesinteger(int32)

Total number of packages

Example: 5
billingObservationsstring[ 0 .. 255 ] characters

Billing observations

Example: "Handle with care"
paymentMethodinteger(int32)

Payment method identifier

Example: 3
firstTerminteger(int32)

First payment term in days

Example: 30
daysTerminteger(int32)

Subsequent payment term in days

Example: 30
termsinteger(int32)

Number of payment terms

Example: 3
proximityTypestring(ApiProximityTypeEnum)

Type of proximity for the delivery

Enum"NEARBY""PREVIOUS""LATER"
Example: "LOCAL"
withholdinginteger(int32)

Withholding identifier

Example: 1
discount1number

First discount percentage

Example: 10
discount2number

Second discount percentage

Example: 5
discountPpnumber

Prompt payment discount percentage

Example: 3
currencyinteger(int32)required

Currency identifier

Example: 1
changenumber

Exchange rate for currency conversion

Example: 1
customerVatTypeinteger(int32)

Customer VAT type identifier

Example: 1
shippingVatTypestring(ApiArticleVatTypeEnum)

VAT type for shipping costs

Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
shippingTerminteger(int32)

Shipping term identifier

Example: 2
shippingVatPercentagenumber

VAT percentage applied to shipping

Example: 21
shippingSurchargePercentagenumber

Surcharge percentage applied to shipping

Example: 5.2
tagsArray of strings

Tags associated with the delivery note

Example: ["urgent","priority"]
invoiceEditObservationsstring

Invoice editing observations

Example: "Delivery note reviewed and approved"
purchasingAccountinteger(int32)

Purchasing account identifier

Example: 6000001
curl -i -X POST \
  https://api.prana.software/api/v1/purchaseDeliveryNote \
  -H 'Content-Type: application/json' \
  -d '{
    "number": 1050,
    "documentDate": "2025-08-07",
    "quantityTotal": 120.5,
    "observations": "Deliver to warehouse B",
    "lines": [
      {
        "id": 1001,
        "articleCombination": 5312,
        "sizeRange": 15,
        "assortment": 8,
        "lineNumber": 1,
        "articleDescription": "Cotton T-shirt - Blue",
        "packages": 3,
        "quantityPerPackage": 12,
        "price": 19.99,
        "lineObservations": "Special discount applied.",
        "details": [
          {
            "id": 200,
            "sizeRangeDetail": 15,
            "width": 12,
            "quantityPerPackage": 9.3
          }
        ],
        "packaging": 1001,
        "discount": 10.5,
        "vatPercentage": 21,
        "reference": "REF-2024-001",
        "picture": "product_image_001.jpg",
        "noAccumulateWarehouse": false,
        "warehouse": 3,
        "assortedPackages": true,
        "shippingVatType": "STANDARD",
        "shippingVatPercentage": 21,
        "shippingSurchargePercentage": 5.2,
        "articleVatType": "STANDARD",
        "surchargePercentage": 5.2,
        "grossAmount": 1000,
        "grossAmountCompanyCurrency": 1000,
        "netAmount": 900,
        "netAmountCompanyCurrency": 900,
        "totalLine": 1089,
        "totalLineCompanyCurrency": 1089,
        "batchList": [
          {
            "id": 11,
            "batch": "LOT-2025B",
            "quantity": 75.5,
            "packages": 2
          }
        ],
        "serialNumberList": [
          {
            "id": 12,
            "serialNumber": "SN-20250807-XYZ"
          }
        ],
        "disbursement": false,
        "concept": "Product purchase"
      }
    ],
    "id": 1001,
    "billingSeries": 5,
    "receivedDate": "2024-08-07",
    "billCode": "BILL-2024-001",
    "locked": false,
    "warehouse": 3,
    "reference": "DN-2024-001",
    "noAccumulateWarehouse": false,
    "supplier": 1001,
    "deliveryNote": "DN-SUPP-2024-001",
    "packages": 5,
    "billingObservations": "Handle with care",
    "paymentMethod": 3,
    "firstTerm": 30,
    "daysTerm": 30,
    "terms": 3,
    "proximityType": "NEARBY",
    "withholding": 1,
    "discount1": 10,
    "discount2": 5,
    "discountPp": 3,
    "currency": 1,
    "change": 1,
    "customerVatType": 1,
    "shippingVatType": "STANDARD",
    "shippingTerm": 2,
    "shippingVatPercentage": 21,
    "shippingSurchargePercentage": 5.2,
    "tags": [
      "urgent",
      "priority"
    ],
    "invoiceEditObservations": "Delivery note reviewed and approved",
    "purchasingAccount": 6000001
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
numberintegerrequired

Unique serial number of the document header.

Example: 1001
documentDatestring(date)required

Date of the document in ISO format (yyyy-MM-dd).

Example: "2024-08-07"
quantityTotalnumber

Total quantity for all document lines.

Example: 200.5
observationsstring

Free text field for any observations related to the document.

Example: "Customer requested urgent delivery"
linesArray of objects(ApiPurchaseDeliveryNoteLineReadDto)

List of detail lines for the document. For structure see: ApiBaseLineReadDto.java

changenumber

Change applied to the invoice or document

Example: 0.5
discount1number

First discount percentage

Example: 5
discount2number

Second discount percentage

Example: 2
discountAmountTotalnumber

Total discount amount

Example: 100
discountAmountTotalCompanyCurrencynumber

Total discount amount in company currency

Example: 95
discountPpnumber

Prompt payment discount percentage

Example: 3
discountPpAmountTotalnumber

Total prompt payment discount amount

Example: 15
discountPpAmountTotalCompanyCurrencynumber

Total prompt payment discount amount in company currency

Example: 14
grossAmountTotalnumber

Gross total amount

Example: 1200
grossAmountTotalCompanyCurrencynumber

Gross total amount in company currency

Example: 1150
netAmountTotalnumber

Net total amount

Example: 1100
netAmountTotalCompanyCurrencynumber

Net total amount in company currency

Example: 1080
vatAmountTotalnumber

Total VAT amount

Example: 230
vatAmountTotalCompanyCurrencynumber

Total VAT amount in company currency

Example: 225
surchargeAmountTotalnumber

Total surcharge amount

Example: 20
surchargeAmountTotalCompanyCurrencynumber

Total surcharge amount in company currency

Example: 18
withholdingnumber

Withholding percentage

Example: 2
withholdingAmountTotalnumber

Total withholding amount

Example: 22
withholdingAmountTotalCompanyCurrencynumber

Total withholding amount in company currency

Example: 21
totalnumber

Total document amount

Example: 1300
totalCompanyCurrencynumber

Total document amount in company currency

Example: 1280
disbursementAmountTotalnumber

Total disbursement amount

Example: 50
disbursementAmountTotalCompanyCurrencynumber

Total disbursement amount in company currency

Example: 48
billingSeriesobject(ApiBillingSeriesListReadDto)

Billing series information

receivedDatestring(date)

Date when the delivery note was received

Example: "2024-08-07"
billCodestring

Bill code reference

Example: "BILL-2024-001"
lockedboolean

Indicates if the delivery note is locked for modifications

Example: false
warehouseobject(ApiWarehouseListReadDto)

Warehouse information

referencestring

Reference number for the delivery note

Example: "DN-2024-001"
noAccumulateWarehouseboolean

Indicates if warehouse accumulation is disabled

Example: false
supplierobject(ApiSupplierListReadDto)

Supplier information

supplierNamestring

Name of the supplier

Example: "ABC Suppliers Ltd."
supplierAddressstring

Address of the supplier

Example: 123
supplierPhonestring

Phone number of the supplier

Example: "+34 91 123 4567"
supplierEmailstring

Email address of the supplier

Example: "contact@abcsuppliers.com"
supplierCifstring

Tax identification number of the supplier

Example: "B12345678"
deliveryNotestring

Delivery note reference

Example: "DN-SUPP-2024-001"
packagesinteger(int32)

Total number of packages

Example: 5
billingObservationsstring

Billing observations

Example: "Handle with care"
paymentMethodobject(ApiPaymentMethodListReadDto)

DTO para listar los métodos de pago disponibles

firstTerminteger(int32)

First payment term in days

Example: 30
daysTerminteger(int32)

Subsequent payment term in days

Example: 30
termsinteger(int32)

Number of payment terms

Example: 3
proximityTypestring(ApiProximityTypeEnum)

Type of proximity for the delivery

Enum"NEARBY""PREVIOUS""LATER"
Example: "LOCAL"
currencyobject(ApiCurrencyListReadDto)

Currency information

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type information

shippingTermobject(ApiShippingTermListReadDto)

Shipping terms information

shippingVatTypestring(ApiArticleVatTypeEnum)

VAT type for shipping costs

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

VAT percentage applied to shipping

Example: 21
shippingSurchargePercentagenumber

Surcharge percentage applied to shipping

Example: 5.2
invoiceDocumentDatestring(date)

Document date of the related invoice

Example: "2024-08-05"
invoiceBillingSeriesCodestring

Billing series code of the related invoice

Example: "A"
tagsArray of strings

Tags associated with the delivery note

Example: ["urgent","priority"]
invoiceEditObservationsstring

Invoice editing observations

Example: "Invoice reviewed and approved"
Response
application/json
{
  "id": 1,
  "number": 1001,
  "documentDate": "2024-08-07",
  "quantityTotal": 200.5,
  "observations": "Customer requested urgent delivery",
  "lines": [
    { … }
  ],
  "change": 0.5,
  "discount1": 5,
  "discount2": 2,
  "discountAmountTotal": 100,
  "discountAmountTotalCompanyCurrency": 95,
  "discountPp": 3,
  "discountPpAmountTotal": 15,
  "discountPpAmountTotalCompanyCurrency": 14,
  "grossAmountTotal": 1200,
  "grossAmountTotalCompanyCurrency": 1150,
  "netAmountTotal": 1100,
  "netAmountTotalCompanyCurrency": 1080,
  "vatAmountTotal": 230,
  "vatAmountTotalCompanyCurrency": 225,
  "surchargeAmountTotal": 20,
  "surchargeAmountTotalCompanyCurrency": 18,
  "withholding": 2,
  "withholdingAmountTotal": 22,
  "withholdingAmountTotalCompanyCurrency": 21,
  "total": 1300,
  "totalCompanyCurrency": 1280,
  "disbursementAmountTotal": 50,
  "disbursementAmountTotalCompanyCurrency": 48,
  "billingSeries": {
    "id": 1,
    "type": "SALE",
    "code": "SER2025",
    "description": "Main invoice series",
    "deposit": true,
    "corrective": false,
    "otherSIF": false
  },
  "receivedDate": "2024-08-07",
  "billCode": "BILL-2024-001",
  "locked": false,
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse",
    "population": "Madrid",
    "active": true
  },
  "reference": "DN-2024-001",
  "noAccumulateWarehouse": false,
  "supplier": {
    "id": 1,
    "code": 20001,
    "cif": "B87654321",
    "commercialName": "Supplier Corp",
    "name": "Supplier Corporation S.L.",
    "address": "Calle Mayor, 10",
    "country": "ES",
    "state": "MAD",
    "postalCode": 28001,
    "city": "Madrid",
    "phone1": "+34911222333",
    "phone2": "+34911444555",
    "currency": "EUR",
    "currencyNomenclature": "Euro",
    "currencyChangeValue": 1,
    "active": true,
    "email": "contact@suppliercorp.com",
    "shippingTerm": 15,
    "tags": [ … ],
    "vatDescription": "IVA General 21%",
    "discount1": 3.5,
    "paymentMethodId": 3,
    "paymentMethod": "Bank Transfer",
    "currencyCode": "EUR",
    "creationDate": "2021-03-15",
    "inactiveDate": "2024-10-01",
    "countryDescription": "España",
    "stateDescription": "Madrid",
    "bankName": "BBVA",
    "account": "ES7921000813610123456789",
    "picture": "https://www.suppliercorp.com/logo.png",
    "pictureToken": "a1b2c3d4e5f6",
    "modifiedOn": "2024-12-10T14:30:00+01:00",
    "web": "https://www.suppliercorp.com"
  },
  "supplierName": "ABC Suppliers Ltd.",
  "supplierAddress": 123,
  "supplierPhone": "+34 91 123 4567",
  "supplierEmail": "contact@abcsuppliers.com",
  "supplierCif": "B12345678",
  "deliveryNote": "DN-SUPP-2024-001",
  "packages": 5,
  "billingObservations": "Handle with care",
  "paymentMethod": {
    "id": 1,
    "code": 1,
    "description": "Transferencia bancaria",
    "document": "Contrato",
    "firstTerm": 30,
    "terms": 3,
    "daysTerms": 30,
    "remittance": true,
    "addToCustomerBase": true,
    "serveFullPrePaid": false,
    "observations": "Requiere verificación bancaria",
    "icon": "fa-credit-card",
    "facturaECode": "01"
  },
  "firstTerm": 30,
  "daysTerm": 30,
  "terms": 3,
  "proximityType": "NEARBY",
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "customerVatType": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "shippingTerm": {
    "id": 1,
    "code": "string",
    "customerPays": true,
    "intrastatCode": "string"
  },
  "shippingVatType": "STANDARD",
  "shippingVatPercentage": 21,
  "shippingSurchargePercentage": 5.2,
  "invoiceDocumentDate": "2024-08-05",
  "invoiceBillingSeriesCode": "A",
  "tags": [
    "urgent",
    "priority"
  ],
  "invoiceEditObservations": "Invoice reviewed and approved"
}

List PurchaseDeliveryNotes

Request

Get all your purchaseDeliveryNotes.

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/purchaseDeliveryNote/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(ApiPurchaseDeliveryNoteListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​billingSeriesstring

Billing series code

Example: "ALB"
data[].​numberinteger(int32)

Document number

Example: 1001
data[].​supplierstring

Supplier name

Example: "ABC Supplies Ltd"
data[].​supplierCommercialNamestring

Supplier commercial name

Example: "ABC Supplies"
data[].​supplierEmailstring

Supplier email address

Example: "contact@abcsupplies.com"
data[].​supplierPhonestring

Supplier phone number

Example: "+34 91 123 4567"
data[].​quantityTotalnumber

Total quantity

Example: 25
data[].​disbursementAmountTotalnumber

Total disbursement amount

Example: 50
data[].​totalnumber

Total amount

Example: 1250
data[].​paymentMethodstring

Payment method code

Example: "TRANSFER"
data[].​paymentMethodDescriptionstring

Payment method description

Example: "Bank Transfer"
data[].​warehousestring

Warehouse name

Example: "Main Warehouse"
data[].​invoiceNumbersstring

Related invoice numbers

Example: "FAC-2024-001, FAC-2024-002"
data[].​purchaseOrderNumbersstring

Related purchase order numbers

Example: "PO-2024-001"
data[].​documentDatestring(date)

Document date

Example: "2024-01-15"
data[].​lockedboolean

Flag indicating if the document is locked

Example: false
data[].​currencyNomenclaturestring

Currency nomenclature

Example: "EUR"
data[].​tagsArray of strings

Tags associated with the document

Example: ["urgent","priority"]
data[].​invoicedboolean

Flag indicating if the document is invoiced

Example: true
data[].​referencestring

Reference number

Example: "ALB-2024-001"
data[].​purchasingAccountCodestring

Purchasing account code

Example: 600
data[].​invoiceEditObservationsstring

Observations for invoice editing

Example: "Special handling required"
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
}

webhook-controller

Operations

api-ecommerce-controller

Operations