API Definition to interact with Prana platform
Prana API (1.0)
https://api.prana.software/api/v1/deliveryNote/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.prana.software/api/v1/deliveryNote/{id}'OK
Date of the document in ISO format (yyyy-MM-dd).
Example: "2024-08-07"
Free text field for any observations related to the document.
Example: "Customer requested urgent delivery"
List of detail lines for the document. For structure see: ApiBaseLineReadDto.java
Total prompt payment discount amount in company currency
Example: 14
Total disbursement amount in company currency
Example: 48
Enum"PURCHASE""PURCHASE_TICKET""SALE""SALE_TICKET""INVOICE_DRAFT"
Example: "INVOICE"
Descripción del método de pago
Example: "Transferencia bancaria"
Indica si se debe añadir a la base de clientes
Example: true
Indica si sirve como pago anticipado completo
Example: false
Observaciones adicionales
Example: "Requiere verificación bancaria"
Enum"AED""AFA""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZM"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "PERCENTAGE"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "FIXED"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "PERCENTAGE"
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
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": true }, "valueDate": "2024-01-20", "customerAddress": { "id": 1, "code": 101, "customerCode": "C10001", "customerName": "Acme S.A.", "customerPostalCode": "03001", "customerAddress": "Avenida de la Estación, 5", "customerCity": "Alicante", "customerState": "A", "customerStateDescription": "Alicante", "customerCountry": "ES", "customerCountryDescription": "Spain", "customerFirstPhoneNumber": "+34965123456", "customerSecondPhoneNumber": "+34965111111", "customerEmail": "cliente@acme.es", "customerCif": "B12345678", "customerId": 10001, "customerCommercialName": "Acme España", "name": "Warehourse", "city": "Alicante", "state": "A", "stateDescription": "Alicante", "postalCode": "03001", "country": "ES", "countryDescription": "Spain", "address": "Street Example, 14", "firstPhoneNumber": "+34965123456", "secondPhoneNumber": "+34965111111", "email": "direccion@acme.es", "cif": "B12345678", "activity": "Wholesale", "brand": "Acme Main Brand", "brandId": 5010, "customerIsActive": true, "isActive": true }, "warehouse": { "id": 1, "code": "ALM01", "description": "Central warehouse" }, "reference": "ALB-2024-001", "rateCode": { "id": 1, "code": "string", "taxesIncluded": true }, "agency": { "id": 1, "code": "AG001", "name": "Fast Transport Agency" }, "locked": false, "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", "discount3": 3, "discount4": 2, "currency": { "id": 1, "code": "strin", "description": "string", "nomenclature": "strin", "isoCode": "USD", "changeValue": 0, "significantDecimalsDocuments": 0, "intermediateDecimalsDocuments": 0, "decimalsCalculatePrices": 0, "decimalsCalculateCosts": 0 }, "iban": "ES9121000418450200051332", "customerVatType": { "id": 1, "code": "GENERAL", "description": "General VAT type" }, "phytosanitaryAuthorizedPerson": { "id": 1, "identificationNumber": "12345678A", "name": "John Doe", "certificateExpirationDate": "2025-12-31", "ropoCode": "string" }, "representative1": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType1": "PERCENTAGE", "commission1": 5, "representative2": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType2": "PERCENTAGE", "commission2": 100, "representative3": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType3": "PERCENTAGE", "commission3": 2.5, "noAccumulateRisk": false, "packages": 5, "grossWeight": 25.5, "netWeight": 23, "volume": 0.5, "billingObservations": "Handle with care", "shippingTerm": { "id": 1, "code": "string", "customerPays": true, "intrastatCode": "string" }, "shippingAmount": 25.5, "shippingVatType": "STANDARD", "shippingVatPercentage": 21, "shippingSurchargePercentage": 5, "tags": [ "urgent", "fragile" ], "invoiceEditObservations": "Special handling required", "collectedAmount": 1500, "collectedAmountCompanyCurrency": 1500 }
Bodyapplication/jsonrequired
List of document lines. For structure, see ApiBaseLineWriteDto.java
International Bank Account Number
Example: "ES9121000418450200051332"
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
Invoice editing observations
Example: "Delivery note reviewed and approved"
https://api.prana.software/api/v1/deliveryNote/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api.prana.software/api/v1/deliveryNote/{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": 200,
"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,
"assortedPackages": true,
"discount": 10.5,
"rsp": 25.99,
"reference": "REF-2024-001",
"picture": "product_image_001.jpg",
"warehouse": 3,
"noAccumulateWarehouse": false,
"brand": 5,
"returnReason": 1,
"received": true,
"accepted": true,
"freeDescription1": "Special handling required",
"freeDescription2": "Custom packaging",
"freeDescription3": "Priority delivery",
"freeDescription4": "Gift wrap",
"freeDescription5": "Express shipping",
"customCommission": false,
"representative1": 2,
"commissionType1": "PERCENTAGE",
"commission1": 5,
"representative2": 3,
"commissionType2": "PERCENTAGE",
"commission2": 3,
"representative3": 4,
"commissionType3": "FIXED",
"commission3": 25,
"articleVatType": "STANDARD",
"vatPercentage": 21,
"surchargePercentage": 5.2,
"grossAmount": 1000,
"grossAmountCompanyCurrency": 1000,
"netAmount": 900,
"netAmountCompanyCurrency": 900,
"totalLine": 1089,
"totalLineCompanyCurrency": 1089,
"batches": [
{
"id": 21,
"batch": 102,
"quantity": 40,
"packages": 3
}
],
"serialNumbers": [
{
"id": 8,
"serialNumber": 202
}
],
"concept": "Product delivery",
"disbursement": false
}
],
"id": 1001,
"billingSeries": 5,
"valueDate": "2024-08-08",
"customerAddress": 15,
"warehouse": 3,
"reference": "DN-2024-001",
"rateCode": 101,
"agency": 10,
"locked": false,
"paymentMethod": 3,
"firstTerm": 30,
"daysTerm": 30,
"terms": 3,
"proximityType": "NEARBY",
"discount1": 10,
"discount2": 5,
"discount3": 2,
"discount4": 1,
"discountPp": 3,
"withholding": 15,
"currency": 1,
"change": 1,
"iban": "ES9121000418450200051332",
"customerVatType": 1,
"representative1": 2,
"commissionType1": "PERCENTAGE",
"commission1": 5,
"representative2": 3,
"commissionType2": "PERCENTAGE",
"commission2": 3,
"representative3": 4,
"commissionType3": "FIXED",
"commission3": 25,
"noAccumulateRisk": false,
"packages": 5,
"grossWeight": 125.5,
"netWeight": 120,
"volume": 2.35,
"billingObservations": "Handle with care",
"shippingTerm": 2,
"shippingAmount": 25.5,
"shippingVatType": "STANDARD",
"shippingVatPercentage": 21,
"shippingSurchargePercentage": 5.2,
"phytosanitaryAuthorizedPerson": 1,
"tags": [
"urgent",
"fragile"
],
"invoiceEditObservations": "Delivery note reviewed and approved",
"salesAccount": 7001
}'OK
Date of the document in ISO format (yyyy-MM-dd).
Example: "2024-08-07"
Free text field for any observations related to the document.
Example: "Customer requested urgent delivery"
List of detail lines for the document. For structure see: ApiBaseLineReadDto.java
Total prompt payment discount amount in company currency
Example: 14
Total disbursement amount in company currency
Example: 48
Enum"PURCHASE""PURCHASE_TICKET""SALE""SALE_TICKET""INVOICE_DRAFT"
Example: "INVOICE"
Descripción del método de pago
Example: "Transferencia bancaria"
Indica si se debe añadir a la base de clientes
Example: true
Indica si sirve como pago anticipado completo
Example: false
Observaciones adicionales
Example: "Requiere verificación bancaria"
Enum"AED""AFA""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZM"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "PERCENTAGE"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "FIXED"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "PERCENTAGE"
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
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": true }, "valueDate": "2024-01-20", "customerAddress": { "id": 1, "code": 101, "customerCode": "C10001", "customerName": "Acme S.A.", "customerPostalCode": "03001", "customerAddress": "Avenida de la Estación, 5", "customerCity": "Alicante", "customerState": "A", "customerStateDescription": "Alicante", "customerCountry": "ES", "customerCountryDescription": "Spain", "customerFirstPhoneNumber": "+34965123456", "customerSecondPhoneNumber": "+34965111111", "customerEmail": "cliente@acme.es", "customerCif": "B12345678", "customerId": 10001, "customerCommercialName": "Acme España", "name": "Warehourse", "city": "Alicante", "state": "A", "stateDescription": "Alicante", "postalCode": "03001", "country": "ES", "countryDescription": "Spain", "address": "Street Example, 14", "firstPhoneNumber": "+34965123456", "secondPhoneNumber": "+34965111111", "email": "direccion@acme.es", "cif": "B12345678", "activity": "Wholesale", "brand": "Acme Main Brand", "brandId": 5010, "customerIsActive": true, "isActive": true }, "warehouse": { "id": 1, "code": "ALM01", "description": "Central warehouse" }, "reference": "ALB-2024-001", "rateCode": { "id": 1, "code": "string", "taxesIncluded": true }, "agency": { "id": 1, "code": "AG001", "name": "Fast Transport Agency" }, "locked": false, "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", "discount3": 3, "discount4": 2, "currency": { "id": 1, "code": "strin", "description": "string", "nomenclature": "strin", "isoCode": "USD", "changeValue": 0, "significantDecimalsDocuments": 0, "intermediateDecimalsDocuments": 0, "decimalsCalculatePrices": 0, "decimalsCalculateCosts": 0 }, "iban": "ES9121000418450200051332", "customerVatType": { "id": 1, "code": "GENERAL", "description": "General VAT type" }, "phytosanitaryAuthorizedPerson": { "id": 1, "identificationNumber": "12345678A", "name": "John Doe", "certificateExpirationDate": "2025-12-31", "ropoCode": "string" }, "representative1": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType1": "PERCENTAGE", "commission1": 5, "representative2": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType2": "PERCENTAGE", "commission2": 100, "representative3": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType3": "PERCENTAGE", "commission3": 2.5, "noAccumulateRisk": false, "packages": 5, "grossWeight": 25.5, "netWeight": 23, "volume": 0.5, "billingObservations": "Handle with care", "shippingTerm": { "id": 1, "code": "string", "customerPays": true, "intrastatCode": "string" }, "shippingAmount": 25.5, "shippingVatType": "STANDARD", "shippingVatPercentage": 21, "shippingSurchargePercentage": 5, "tags": [ "urgent", "fragile" ], "invoiceEditObservations": "Special handling required", "collectedAmount": 1500, "collectedAmountCompanyCurrency": 1500 }
Bodyapplication/jsonrequired
List of document lines. For structure, see ApiBaseLineWriteDto.java
International Bank Account Number
Example: "ES9121000418450200051332"
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
Invoice editing observations
Example: "Delivery note reviewed and approved"
https://api.prana.software/api/v1/deliveryNote
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.prana.software/api/v1/deliveryNote \
-H 'Content-Type: application/json' \
-d '{
"number": 1050,
"documentDate": "2025-08-07",
"quantityTotal": 120.5,
"observations": "Deliver to warehouse B",
"lines": [
{
"id": 1001,
"articleCombination": 200,
"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,
"assortedPackages": true,
"discount": 10.5,
"rsp": 25.99,
"reference": "REF-2024-001",
"picture": "product_image_001.jpg",
"warehouse": 3,
"noAccumulateWarehouse": false,
"brand": 5,
"returnReason": 1,
"received": true,
"accepted": true,
"freeDescription1": "Special handling required",
"freeDescription2": "Custom packaging",
"freeDescription3": "Priority delivery",
"freeDescription4": "Gift wrap",
"freeDescription5": "Express shipping",
"customCommission": false,
"representative1": 2,
"commissionType1": "PERCENTAGE",
"commission1": 5,
"representative2": 3,
"commissionType2": "PERCENTAGE",
"commission2": 3,
"representative3": 4,
"commissionType3": "FIXED",
"commission3": 25,
"articleVatType": "STANDARD",
"vatPercentage": 21,
"surchargePercentage": 5.2,
"grossAmount": 1000,
"grossAmountCompanyCurrency": 1000,
"netAmount": 900,
"netAmountCompanyCurrency": 900,
"totalLine": 1089,
"totalLineCompanyCurrency": 1089,
"batches": [
{
"id": 21,
"batch": 102,
"quantity": 40,
"packages": 3
}
],
"serialNumbers": [
{
"id": 8,
"serialNumber": 202
}
],
"concept": "Product delivery",
"disbursement": false
}
],
"id": 1001,
"billingSeries": 5,
"valueDate": "2024-08-08",
"customerAddress": 15,
"warehouse": 3,
"reference": "DN-2024-001",
"rateCode": 101,
"agency": 10,
"locked": false,
"paymentMethod": 3,
"firstTerm": 30,
"daysTerm": 30,
"terms": 3,
"proximityType": "NEARBY",
"discount1": 10,
"discount2": 5,
"discount3": 2,
"discount4": 1,
"discountPp": 3,
"withholding": 15,
"currency": 1,
"change": 1,
"iban": "ES9121000418450200051332",
"customerVatType": 1,
"representative1": 2,
"commissionType1": "PERCENTAGE",
"commission1": 5,
"representative2": 3,
"commissionType2": "PERCENTAGE",
"commission2": 3,
"representative3": 4,
"commissionType3": "FIXED",
"commission3": 25,
"noAccumulateRisk": false,
"packages": 5,
"grossWeight": 125.5,
"netWeight": 120,
"volume": 2.35,
"billingObservations": "Handle with care",
"shippingTerm": 2,
"shippingAmount": 25.5,
"shippingVatType": "STANDARD",
"shippingVatPercentage": 21,
"shippingSurchargePercentage": 5.2,
"phytosanitaryAuthorizedPerson": 1,
"tags": [
"urgent",
"fragile"
],
"invoiceEditObservations": "Delivery note reviewed and approved",
"salesAccount": 7001
}'OK
Date of the document in ISO format (yyyy-MM-dd).
Example: "2024-08-07"
Free text field for any observations related to the document.
Example: "Customer requested urgent delivery"
List of detail lines for the document. For structure see: ApiBaseLineReadDto.java
Total prompt payment discount amount in company currency
Example: 14
Total disbursement amount in company currency
Example: 48
Enum"PURCHASE""PURCHASE_TICKET""SALE""SALE_TICKET""INVOICE_DRAFT"
Example: "INVOICE"
Descripción del método de pago
Example: "Transferencia bancaria"
Indica si se debe añadir a la base de clientes
Example: true
Indica si sirve como pago anticipado completo
Example: false
Observaciones adicionales
Example: "Requiere verificación bancaria"
Enum"AED""AFA""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZM"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "PERCENTAGE"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "FIXED"
Enum"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
Example: "PERCENTAGE"
Enum"SUPER_REDUCED""REDUCED""GENERAL""EXEMPT"
Example: "GENERAL"
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": true }, "valueDate": "2024-01-20", "customerAddress": { "id": 1, "code": 101, "customerCode": "C10001", "customerName": "Acme S.A.", "customerPostalCode": "03001", "customerAddress": "Avenida de la Estación, 5", "customerCity": "Alicante", "customerState": "A", "customerStateDescription": "Alicante", "customerCountry": "ES", "customerCountryDescription": "Spain", "customerFirstPhoneNumber": "+34965123456", "customerSecondPhoneNumber": "+34965111111", "customerEmail": "cliente@acme.es", "customerCif": "B12345678", "customerId": 10001, "customerCommercialName": "Acme España", "name": "Warehourse", "city": "Alicante", "state": "A", "stateDescription": "Alicante", "postalCode": "03001", "country": "ES", "countryDescription": "Spain", "address": "Street Example, 14", "firstPhoneNumber": "+34965123456", "secondPhoneNumber": "+34965111111", "email": "direccion@acme.es", "cif": "B12345678", "activity": "Wholesale", "brand": "Acme Main Brand", "brandId": 5010, "customerIsActive": true, "isActive": true }, "warehouse": { "id": 1, "code": "ALM01", "description": "Central warehouse" }, "reference": "ALB-2024-001", "rateCode": { "id": 1, "code": "string", "taxesIncluded": true }, "agency": { "id": 1, "code": "AG001", "name": "Fast Transport Agency" }, "locked": false, "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", "discount3": 3, "discount4": 2, "currency": { "id": 1, "code": "strin", "description": "string", "nomenclature": "strin", "isoCode": "USD", "changeValue": 0, "significantDecimalsDocuments": 0, "intermediateDecimalsDocuments": 0, "decimalsCalculatePrices": 0, "decimalsCalculateCosts": 0 }, "iban": "ES9121000418450200051332", "customerVatType": { "id": 1, "code": "GENERAL", "description": "General VAT type" }, "phytosanitaryAuthorizedPerson": { "id": 1, "identificationNumber": "12345678A", "name": "John Doe", "certificateExpirationDate": "2025-12-31", "ropoCode": "string" }, "representative1": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType1": "PERCENTAGE", "commission1": 5, "representative2": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType2": "PERCENTAGE", "commission2": 100, "representative3": { "id": 1, "code": 0, "name": "string", "cif": "string", "population": "string", "country": "string", "state": "string", "phone1": "string", "phone2": "string", "email": "string", "commission": 0, "commissionType": "PERCENTAGE", "irpfPercentage": 0, "vatPercentage": 0, "subAgentOf": "string", "userB2bMobility": "string", "enableB2bMobility": true }, "commissionType3": "PERCENTAGE", "commission3": 2.5, "noAccumulateRisk": false, "packages": 5, "grossWeight": 25.5, "netWeight": 23, "volume": 0.5, "billingObservations": "Handle with care", "shippingTerm": { "id": 1, "code": "string", "customerPays": true, "intrastatCode": "string" }, "shippingAmount": 25.5, "shippingVatType": "STANDARD", "shippingVatPercentage": 21, "shippingSurchargePercentage": 5, "tags": [ "urgent", "fragile" ], "invoiceEditObservations": "Special handling required", "collectedAmount": 1500, "collectedAmountCompanyCurrency": 1500 }
https://api.prana.software/api/v1/deliveryNote/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.prana.software/api/v1/deliveryNote/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
}'Response
application/json
{ "data": [ { … } ], "page": 0, "total": 150, "pages": 14, "size": 10 }