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

Get Entry

Request

Get a specific entry.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codeinteger(int32)

Unique identifier code of the entry

Example: 10123
periodIdinteger(int32)

Identifier of the accounting period

Example: 2024
journalobject(ApiJournalListReadDto)

Journal information where the entry is recorded

entryDatestring(date)

Date of the accounting entry

Example: "2024-05-15"
valueDatestring(date)

Value date of the accounting entry

Example: "2024-05-16"
currencyobject(ApiCurrencyListReadDto)

Currency of the accounting entry

currencyChangenumber

Exchange rate applied for the currency

Example: 1.12
documentstring

Reference document number

Example: "DOC-2024-015"
originalDocumentstring

Original document reference

Example: "INV-2024-077"
observationsstring

Additional observations or comments for the entry

Example: "Manual adjustment for reconciliation"
debitnumber

Total debit amount of the entry

Example: 1500
creditnumber

Total credit amount of the entry

Example: 1500
consolidatedboolean

Indicates if the entry is consolidated

Example: true
originstring(AccountingEntryOriginEnum)

Origin information of the accounting entry

Enum"AMORTIZATION""BALANCE""RECEIPT""PAYMENT""POS_INVOICE""DELIVERY_NOTE""PAYROLL""SAGE""BANK"
vatRecordobject(ApiVatRecordListReadDto)

VAT record associated with the entry

paymentIdinteger(int32)

Identifier of the related payment

Example: 5678
exportedboolean

Indicates if the entry has been exported

Example: false
controlCodeinteger(int32)

Control code for internal use

Example: 445
linesobject(ApiEntryDetailReadDto)

List of entry detail lines

filesobject(ApiEntryFileListReadDto)

List of files attached to the entry

receiptCollectionobject(ApiReceiptCollectionListReadDto)

Receipt collection associated with the entry

purchaseReceiptCollectionobject(ApiPurchaseReceiptCollectionListReadDto)

Purchase receipt collection associated with the entry

remittanceReceiptobject(ApiReceiptCollectionListReadDto)

Remittance receipt associated with the entry

closingTypestring(ApiEntryClosingTypeEnum)

Type of closing applied to the entry

Enum"OPENING""CLOSING""OPERATING_CLOSING"
Example: "YEAR_END"
exportedAccountingboolean

Indicates if the entry has been exported to accounting system

Example: false
Response
application/json
{
  "id": 1,
  "code": 10123,
  "periodId": 2024,
  "journal": {
    "id": 1,
    "code": "SALES",
    "description": "Sales Journal"
  },
  "entryDate": "2024-05-15",
  "valueDate": "2024-05-16",
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "currencyChange": 1.12,
  "document": "DOC-2024-015",
  "originalDocument": "INV-2024-077",
  "observations": "Manual adjustment for reconciliation",
  "debit": 1500,
  "credit": 1500,
  "consolidated": true,
  "origin": "AMORTIZATION",
  "vatRecord": {
    "id": 1,
    "vatType": "GENERAL",
    "billingSeriesCode": "BS001",
    "billingSeriesDescription": "Standard Billing Series",
    "code": 12345,
    "vatOperationTypeCode": "E01",
    "vatOperationTypeDescription": "Intra-community acquisition of goods",
    "description": "Purchase of office supplies with general VAT",
    "cif": "B12345678",
    "invoiceDate": "2024-05-15",
    "accountingDate": "2024-05-16",
    "totalAmount": 1500,
    "invoiceDescription": "Purchase of raw materials",
    "invoiceNumber": "INV-2024-001"
  },
  "paymentId": 5678,
  "exported": false,
  "controlCode": 445,
  "lines": {
    "id": 1,
    "lineNumber": 1,
    "concept": { … },
    "conceptDescription": "Purchase of office supplies",
    "extension": "EXT-REF-01",
    "document": "INV-2024-099",
    "account": { … },
    "debit": 1200,
    "credit": 1200,
    "reconciliation": 0,
    "projectId": 45,
    "currencyAmount": 1000,
    "currencyDebit": 500,
    "currencyCredit": 500,
    "tags": [ … ]
  },
  "files": {
    "id": 1,
    "token": "729eda1d03b34634b8e3c81a8b2d0974",
    "url": "https://apihost.com/file/729eda1d03b34634b8e3c81a8b2d0974",
    "fileName": "invoice_2023.pdf",
    "fileExtension": "pdf",
    "fileSize": 1048576,
    "modifiedOn": "2024-08-07T18:10:55"
  },
  "receiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "purchaseReceiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "supplierCode": "string",
    "supplierBusinessName": "string",
    "supplierName": "string"
  },
  "remittanceReceipt": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "closingType": "OPENING",
  "exportedAccounting": false
}

Update Entry

Request

Update a specific Entry.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
idinteger(int32)

Unique identifier of the entry (only required for updates)

Example: 10123
codeinteger(int32)

Code of the accounting entry

Example: 5001
journalinteger(int32)

Identifier of the journal where the entry is recorded

Example: 3
entryDatestring(date)

Date of the accounting entry

Example: "2024-05-15"
valueDatestring(date)

Value date of the accounting entry

Example: "2024-05-16"
currencyinteger(int32)

Identifier of the currency used in the entry

Example: 1
currencyChangenumber

Exchange rate applied for the currency

Example: 1.123456789
documentstring[ 0 .. 36 ] characters

Reference document number

Example: "DOC-2024-015"
originalDocumentstring[ 0 .. 36 ] characters

Original document reference

Example: "INV-2024-077"
observationsstring

Additional observations or comments for the entry

Example: "Manual adjustment for reconciliation"
debitnumber

Total debit amount of the entry

Example: 1500
creditnumber

Total credit amount of the entry

Example: 1500
consolidatedboolean

Indicates if the entry is consolidated

Example: false
originstring(AccountingEntryOriginEnum)

Origin information of the accounting entry

Enum"AMORTIZATION""BALANCE""RECEIPT""PAYMENT""POS_INVOICE""DELIVERY_NOTE""PAYROLL""SAGE""BANK"
vatRecordinteger(int32)

Identifier of the VAT record associated with the entry

Example: 25
paymentIdinteger(int32)

Identifier of the related payment

Example: 5678
exportedboolean

Indicates if the entry has been exported

Example: true
controlCodeinteger(int32)

Control code for internal use

Example: 445
linesobject(ApiEntryDetailWriteDto)

List of entry detail lines

filesobject(ApiEntryFileWriteDto)

List of files attached to the entry

receiptCollectioninteger(int32)

Identifier of the receipt collection associated with the entry

Example: 321
purchaseReceiptCollectioninteger(int32)

Identifier of the purchase receipt collection associated with the entry

Example: 654
remittanceReceiptinteger(int32)

Identifier of the remittance receipt associated with the entry

Example: 789
closingTypestring[ 0 .. 20 ] characters

Type of closing applied to the entry

Example: "YEAR_END"
exportedAccountingboolean

Indicates if the entry has been exported to accounting system

Example: false
curl -i -X PUT \
  'https://api.prana.software/api/v1/entry/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 10123,
    "code": 5001,
    "journal": 3,
    "entryDate": "2024-05-15",
    "valueDate": "2024-05-16",
    "currency": 1,
    "currencyChange": 1.123456789,
    "document": "DOC-2024-015",
    "originalDocument": "INV-2024-077",
    "observations": "Manual adjustment for reconciliation",
    "debit": 1500,
    "credit": 1500,
    "consolidated": false,
    "origin": "AMORTIZATION",
    "vatRecord": 25,
    "paymentId": 5678,
    "exported": true,
    "controlCode": 445,
    "lines": {
      "id": 1001,
      "entry": 5001,
      "lineNumber": 1,
      "concept": 200,
      "conceptDescription": "Purchase of office supplies",
      "extension": "EXT-REF-01",
      "document": "INV-2024-099",
      "account": 6000,
      "credit": 1200,
      "debit": 1200,
      "reconciliation": 0,
      "projectId": 45,
      "currencyAmount": 1000,
      "currencyDebit": 500,
      "currencyCredit": 500,
      "tags": [
        "adjustment",
        "VAT"
      ]
    },
    "files": {
      "id": 0,
      "token": "string",
      "fileName": "string",
      "fileExtension": "string",
      "fileSize": 0
    },
    "receiptCollection": 321,
    "purchaseReceiptCollection": 654,
    "remittanceReceipt": 789,
    "closingType": "YEAR_END",
    "exportedAccounting": false
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codeinteger(int32)

Unique identifier code of the entry

Example: 10123
periodIdinteger(int32)

Identifier of the accounting period

Example: 2024
journalobject(ApiJournalListReadDto)

Journal information where the entry is recorded

entryDatestring(date)

Date of the accounting entry

Example: "2024-05-15"
valueDatestring(date)

Value date of the accounting entry

Example: "2024-05-16"
currencyobject(ApiCurrencyListReadDto)

Currency of the accounting entry

currencyChangenumber

Exchange rate applied for the currency

Example: 1.12
documentstring

Reference document number

Example: "DOC-2024-015"
originalDocumentstring

Original document reference

Example: "INV-2024-077"
observationsstring

Additional observations or comments for the entry

Example: "Manual adjustment for reconciliation"
debitnumber

Total debit amount of the entry

Example: 1500
creditnumber

Total credit amount of the entry

Example: 1500
consolidatedboolean

Indicates if the entry is consolidated

Example: true
originstring(AccountingEntryOriginEnum)

Origin information of the accounting entry

Enum"AMORTIZATION""BALANCE""RECEIPT""PAYMENT""POS_INVOICE""DELIVERY_NOTE""PAYROLL""SAGE""BANK"
vatRecordobject(ApiVatRecordListReadDto)

VAT record associated with the entry

paymentIdinteger(int32)

Identifier of the related payment

Example: 5678
exportedboolean

Indicates if the entry has been exported

Example: false
controlCodeinteger(int32)

Control code for internal use

Example: 445
linesobject(ApiEntryDetailReadDto)

List of entry detail lines

filesobject(ApiEntryFileListReadDto)

List of files attached to the entry

receiptCollectionobject(ApiReceiptCollectionListReadDto)

Receipt collection associated with the entry

purchaseReceiptCollectionobject(ApiPurchaseReceiptCollectionListReadDto)

Purchase receipt collection associated with the entry

remittanceReceiptobject(ApiReceiptCollectionListReadDto)

Remittance receipt associated with the entry

closingTypestring(ApiEntryClosingTypeEnum)

Type of closing applied to the entry

Enum"OPENING""CLOSING""OPERATING_CLOSING"
Example: "YEAR_END"
exportedAccountingboolean

Indicates if the entry has been exported to accounting system

Example: false
Response
application/json
{
  "id": 1,
  "code": 10123,
  "periodId": 2024,
  "journal": {
    "id": 1,
    "code": "SALES",
    "description": "Sales Journal"
  },
  "entryDate": "2024-05-15",
  "valueDate": "2024-05-16",
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "currencyChange": 1.12,
  "document": "DOC-2024-015",
  "originalDocument": "INV-2024-077",
  "observations": "Manual adjustment for reconciliation",
  "debit": 1500,
  "credit": 1500,
  "consolidated": true,
  "origin": "AMORTIZATION",
  "vatRecord": {
    "id": 1,
    "vatType": "GENERAL",
    "billingSeriesCode": "BS001",
    "billingSeriesDescription": "Standard Billing Series",
    "code": 12345,
    "vatOperationTypeCode": "E01",
    "vatOperationTypeDescription": "Intra-community acquisition of goods",
    "description": "Purchase of office supplies with general VAT",
    "cif": "B12345678",
    "invoiceDate": "2024-05-15",
    "accountingDate": "2024-05-16",
    "totalAmount": 1500,
    "invoiceDescription": "Purchase of raw materials",
    "invoiceNumber": "INV-2024-001"
  },
  "paymentId": 5678,
  "exported": false,
  "controlCode": 445,
  "lines": {
    "id": 1,
    "lineNumber": 1,
    "concept": { … },
    "conceptDescription": "Purchase of office supplies",
    "extension": "EXT-REF-01",
    "document": "INV-2024-099",
    "account": { … },
    "debit": 1200,
    "credit": 1200,
    "reconciliation": 0,
    "projectId": 45,
    "currencyAmount": 1000,
    "currencyDebit": 500,
    "currencyCredit": 500,
    "tags": [ … ]
  },
  "files": {
    "id": 1,
    "token": "729eda1d03b34634b8e3c81a8b2d0974",
    "url": "https://apihost.com/file/729eda1d03b34634b8e3c81a8b2d0974",
    "fileName": "invoice_2023.pdf",
    "fileExtension": "pdf",
    "fileSize": 1048576,
    "modifiedOn": "2024-08-07T18:10:55"
  },
  "receiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "purchaseReceiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "supplierCode": "string",
    "supplierBusinessName": "string",
    "supplierName": "string"
  },
  "remittanceReceipt": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "closingType": "OPENING",
  "exportedAccounting": false
}

Delete Entry

Request

Delete specific entry.

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

Responses

OK

Patch Entry

Request

Patch specific Entry.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codeinteger(int32)

Unique identifier code of the entry

Example: 10123
periodIdinteger(int32)

Identifier of the accounting period

Example: 2024
journalobject(ApiJournalListReadDto)

Journal information where the entry is recorded

entryDatestring(date)

Date of the accounting entry

Example: "2024-05-15"
valueDatestring(date)

Value date of the accounting entry

Example: "2024-05-16"
currencyobject(ApiCurrencyListReadDto)

Currency of the accounting entry

currencyChangenumber

Exchange rate applied for the currency

Example: 1.12
documentstring

Reference document number

Example: "DOC-2024-015"
originalDocumentstring

Original document reference

Example: "INV-2024-077"
observationsstring

Additional observations or comments for the entry

Example: "Manual adjustment for reconciliation"
debitnumber

Total debit amount of the entry

Example: 1500
creditnumber

Total credit amount of the entry

Example: 1500
consolidatedboolean

Indicates if the entry is consolidated

Example: true
originstring(AccountingEntryOriginEnum)

Origin information of the accounting entry

Enum"AMORTIZATION""BALANCE""RECEIPT""PAYMENT""POS_INVOICE""DELIVERY_NOTE""PAYROLL""SAGE""BANK"
vatRecordobject(ApiVatRecordListReadDto)

VAT record associated with the entry

paymentIdinteger(int32)

Identifier of the related payment

Example: 5678
exportedboolean

Indicates if the entry has been exported

Example: false
controlCodeinteger(int32)

Control code for internal use

Example: 445
linesobject(ApiEntryDetailReadDto)

List of entry detail lines

filesobject(ApiEntryFileListReadDto)

List of files attached to the entry

receiptCollectionobject(ApiReceiptCollectionListReadDto)

Receipt collection associated with the entry

purchaseReceiptCollectionobject(ApiPurchaseReceiptCollectionListReadDto)

Purchase receipt collection associated with the entry

remittanceReceiptobject(ApiReceiptCollectionListReadDto)

Remittance receipt associated with the entry

closingTypestring(ApiEntryClosingTypeEnum)

Type of closing applied to the entry

Enum"OPENING""CLOSING""OPERATING_CLOSING"
Example: "YEAR_END"
exportedAccountingboolean

Indicates if the entry has been exported to accounting system

Example: false
Response
application/json
{
  "id": 1,
  "code": 10123,
  "periodId": 2024,
  "journal": {
    "id": 1,
    "code": "SALES",
    "description": "Sales Journal"
  },
  "entryDate": "2024-05-15",
  "valueDate": "2024-05-16",
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "currencyChange": 1.12,
  "document": "DOC-2024-015",
  "originalDocument": "INV-2024-077",
  "observations": "Manual adjustment for reconciliation",
  "debit": 1500,
  "credit": 1500,
  "consolidated": true,
  "origin": "AMORTIZATION",
  "vatRecord": {
    "id": 1,
    "vatType": "GENERAL",
    "billingSeriesCode": "BS001",
    "billingSeriesDescription": "Standard Billing Series",
    "code": 12345,
    "vatOperationTypeCode": "E01",
    "vatOperationTypeDescription": "Intra-community acquisition of goods",
    "description": "Purchase of office supplies with general VAT",
    "cif": "B12345678",
    "invoiceDate": "2024-05-15",
    "accountingDate": "2024-05-16",
    "totalAmount": 1500,
    "invoiceDescription": "Purchase of raw materials",
    "invoiceNumber": "INV-2024-001"
  },
  "paymentId": 5678,
  "exported": false,
  "controlCode": 445,
  "lines": {
    "id": 1,
    "lineNumber": 1,
    "concept": { … },
    "conceptDescription": "Purchase of office supplies",
    "extension": "EXT-REF-01",
    "document": "INV-2024-099",
    "account": { … },
    "debit": 1200,
    "credit": 1200,
    "reconciliation": 0,
    "projectId": 45,
    "currencyAmount": 1000,
    "currencyDebit": 500,
    "currencyCredit": 500,
    "tags": [ … ]
  },
  "files": {
    "id": 1,
    "token": "729eda1d03b34634b8e3c81a8b2d0974",
    "url": "https://apihost.com/file/729eda1d03b34634b8e3c81a8b2d0974",
    "fileName": "invoice_2023.pdf",
    "fileExtension": "pdf",
    "fileSize": 1048576,
    "modifiedOn": "2024-08-07T18:10:55"
  },
  "receiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "purchaseReceiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "supplierCode": "string",
    "supplierBusinessName": "string",
    "supplierName": "string"
  },
  "remittanceReceipt": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "closingType": "OPENING",
  "exportedAccounting": false
}

Create Entry

Request

Create a new entry.

Bodyapplication/jsonrequired
idinteger(int32)

Unique identifier of the entry (only required for updates)

Example: 10123
codeinteger(int32)

Code of the accounting entry

Example: 5001
journalinteger(int32)

Identifier of the journal where the entry is recorded

Example: 3
entryDatestring(date)

Date of the accounting entry

Example: "2024-05-15"
valueDatestring(date)

Value date of the accounting entry

Example: "2024-05-16"
currencyinteger(int32)

Identifier of the currency used in the entry

Example: 1
currencyChangenumber

Exchange rate applied for the currency

Example: 1.123456789
documentstring[ 0 .. 36 ] characters

Reference document number

Example: "DOC-2024-015"
originalDocumentstring[ 0 .. 36 ] characters

Original document reference

Example: "INV-2024-077"
observationsstring

Additional observations or comments for the entry

Example: "Manual adjustment for reconciliation"
debitnumber

Total debit amount of the entry

Example: 1500
creditnumber

Total credit amount of the entry

Example: 1500
consolidatedboolean

Indicates if the entry is consolidated

Example: false
originstring(AccountingEntryOriginEnum)

Origin information of the accounting entry

Enum"AMORTIZATION""BALANCE""RECEIPT""PAYMENT""POS_INVOICE""DELIVERY_NOTE""PAYROLL""SAGE""BANK"
vatRecordinteger(int32)

Identifier of the VAT record associated with the entry

Example: 25
paymentIdinteger(int32)

Identifier of the related payment

Example: 5678
exportedboolean

Indicates if the entry has been exported

Example: true
controlCodeinteger(int32)

Control code for internal use

Example: 445
linesobject(ApiEntryDetailWriteDto)

List of entry detail lines

filesobject(ApiEntryFileWriteDto)

List of files attached to the entry

receiptCollectioninteger(int32)

Identifier of the receipt collection associated with the entry

Example: 321
purchaseReceiptCollectioninteger(int32)

Identifier of the purchase receipt collection associated with the entry

Example: 654
remittanceReceiptinteger(int32)

Identifier of the remittance receipt associated with the entry

Example: 789
closingTypestring[ 0 .. 20 ] characters

Type of closing applied to the entry

Example: "YEAR_END"
exportedAccountingboolean

Indicates if the entry has been exported to accounting system

Example: false
curl -i -X POST \
  https://api.prana.software/api/v1/entry \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 10123,
    "code": 5001,
    "journal": 3,
    "entryDate": "2024-05-15",
    "valueDate": "2024-05-16",
    "currency": 1,
    "currencyChange": 1.123456789,
    "document": "DOC-2024-015",
    "originalDocument": "INV-2024-077",
    "observations": "Manual adjustment for reconciliation",
    "debit": 1500,
    "credit": 1500,
    "consolidated": false,
    "origin": "AMORTIZATION",
    "vatRecord": 25,
    "paymentId": 5678,
    "exported": true,
    "controlCode": 445,
    "lines": {
      "id": 1001,
      "entry": 5001,
      "lineNumber": 1,
      "concept": 200,
      "conceptDescription": "Purchase of office supplies",
      "extension": "EXT-REF-01",
      "document": "INV-2024-099",
      "account": 6000,
      "credit": 1200,
      "debit": 1200,
      "reconciliation": 0,
      "projectId": 45,
      "currencyAmount": 1000,
      "currencyDebit": 500,
      "currencyCredit": 500,
      "tags": [
        "adjustment",
        "VAT"
      ]
    },
    "files": {
      "id": 0,
      "token": "string",
      "fileName": "string",
      "fileExtension": "string",
      "fileSize": 0
    },
    "receiptCollection": 321,
    "purchaseReceiptCollection": 654,
    "remittanceReceipt": 789,
    "closingType": "YEAR_END",
    "exportedAccounting": false
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codeinteger(int32)

Unique identifier code of the entry

Example: 10123
periodIdinteger(int32)

Identifier of the accounting period

Example: 2024
journalobject(ApiJournalListReadDto)

Journal information where the entry is recorded

entryDatestring(date)

Date of the accounting entry

Example: "2024-05-15"
valueDatestring(date)

Value date of the accounting entry

Example: "2024-05-16"
currencyobject(ApiCurrencyListReadDto)

Currency of the accounting entry

currencyChangenumber

Exchange rate applied for the currency

Example: 1.12
documentstring

Reference document number

Example: "DOC-2024-015"
originalDocumentstring

Original document reference

Example: "INV-2024-077"
observationsstring

Additional observations or comments for the entry

Example: "Manual adjustment for reconciliation"
debitnumber

Total debit amount of the entry

Example: 1500
creditnumber

Total credit amount of the entry

Example: 1500
consolidatedboolean

Indicates if the entry is consolidated

Example: true
originstring(AccountingEntryOriginEnum)

Origin information of the accounting entry

Enum"AMORTIZATION""BALANCE""RECEIPT""PAYMENT""POS_INVOICE""DELIVERY_NOTE""PAYROLL""SAGE""BANK"
vatRecordobject(ApiVatRecordListReadDto)

VAT record associated with the entry

paymentIdinteger(int32)

Identifier of the related payment

Example: 5678
exportedboolean

Indicates if the entry has been exported

Example: false
controlCodeinteger(int32)

Control code for internal use

Example: 445
linesobject(ApiEntryDetailReadDto)

List of entry detail lines

filesobject(ApiEntryFileListReadDto)

List of files attached to the entry

receiptCollectionobject(ApiReceiptCollectionListReadDto)

Receipt collection associated with the entry

purchaseReceiptCollectionobject(ApiPurchaseReceiptCollectionListReadDto)

Purchase receipt collection associated with the entry

remittanceReceiptobject(ApiReceiptCollectionListReadDto)

Remittance receipt associated with the entry

closingTypestring(ApiEntryClosingTypeEnum)

Type of closing applied to the entry

Enum"OPENING""CLOSING""OPERATING_CLOSING"
Example: "YEAR_END"
exportedAccountingboolean

Indicates if the entry has been exported to accounting system

Example: false
Response
application/json
{
  "id": 1,
  "code": 10123,
  "periodId": 2024,
  "journal": {
    "id": 1,
    "code": "SALES",
    "description": "Sales Journal"
  },
  "entryDate": "2024-05-15",
  "valueDate": "2024-05-16",
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "currencyChange": 1.12,
  "document": "DOC-2024-015",
  "originalDocument": "INV-2024-077",
  "observations": "Manual adjustment for reconciliation",
  "debit": 1500,
  "credit": 1500,
  "consolidated": true,
  "origin": "AMORTIZATION",
  "vatRecord": {
    "id": 1,
    "vatType": "GENERAL",
    "billingSeriesCode": "BS001",
    "billingSeriesDescription": "Standard Billing Series",
    "code": 12345,
    "vatOperationTypeCode": "E01",
    "vatOperationTypeDescription": "Intra-community acquisition of goods",
    "description": "Purchase of office supplies with general VAT",
    "cif": "B12345678",
    "invoiceDate": "2024-05-15",
    "accountingDate": "2024-05-16",
    "totalAmount": 1500,
    "invoiceDescription": "Purchase of raw materials",
    "invoiceNumber": "INV-2024-001"
  },
  "paymentId": 5678,
  "exported": false,
  "controlCode": 445,
  "lines": {
    "id": 1,
    "lineNumber": 1,
    "concept": { … },
    "conceptDescription": "Purchase of office supplies",
    "extension": "EXT-REF-01",
    "document": "INV-2024-099",
    "account": { … },
    "debit": 1200,
    "credit": 1200,
    "reconciliation": 0,
    "projectId": 45,
    "currencyAmount": 1000,
    "currencyDebit": 500,
    "currencyCredit": 500,
    "tags": [ … ]
  },
  "files": {
    "id": 1,
    "token": "729eda1d03b34634b8e3c81a8b2d0974",
    "url": "https://apihost.com/file/729eda1d03b34634b8e3c81a8b2d0974",
    "fileName": "invoice_2023.pdf",
    "fileExtension": "pdf",
    "fileSize": 1048576,
    "modifiedOn": "2024-08-07T18:10:55"
  },
  "receiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "purchaseReceiptCollection": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "supplierCode": "string",
    "supplierBusinessName": "string",
    "supplierName": "string"
  },
  "remittanceReceipt": {
    "id": 1,
    "orderNumber": 1,
    "collectionDate": "2024-03-15",
    "country": "Spain",
    "accountCode": 572000003,
    "observations": "First payment received via bank transfer.",
    "amount": 1000.5,
    "accounted": true,
    "bankName": "Bank of Spain",
    "customerCode": "CUST001",
    "customerBusinessName": "Clavei S.A.",
    "customerName": "Ana Martínez"
  },
  "closingType": "OPENING",
  "exportedAccounting": false
}

List Entries

Request

Get all your entries.

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/entry/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(ApiEntryListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​codeinteger(int32)

Unique identifier code of the entry

Example: 10123
data[].​periodIdinteger(int32)

Identifier of the accounting period

Example: 2024
data[].​entryDatestring(date)

Date of the accounting entry

Example: "2024-05-15"
data[].​debitnumber

Total debit amount of the entry

Example: 1500
data[].​creditnumber

Total credit amount of the entry

Example: 1500
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
}

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

webhook-controller

Operations

api-ecommerce-controller

Operations