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

Get Bank

Request

Get a specific bank.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Unique code for the bank.

Example: "ES1234"
namestringrequired

Name of the bank.

Example: "CLAVEI BANK"
ibanstring

IBAN of the bank account.

Example: "ES9820385778983000760236"
swiftstring

SWIFT/BIC code.

Example: "BSABESBBXXX"
inactiveboolean

Indicates if the bank is inactive.

Example: false
observationsstring

Observations about the bank.

Example: "Merges with main branch yearly"
riskGrantednumber

Granted risk limit for the bank.

Example: 25000
riskConsumednumber

Consumed risk for the bank.

Example: 13000.55
riskAvailablenumber

Available risk for the bank.

Example: 12000
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account details. See ApiChartAccountListReadDto.

remittancePresenterSuffixstring

Suffix for the remittance presenter.

Example: "0001"
reportPrtryInsteadCdboolean

Indicates if Prtry should be reported instead of Cd.

Example: false
skipBicorbeiTagsboolean

Indicates if BIC/ORBEI tags will be skipped.

Example: false
skipIndividualDataboolean

Indicates if individual data will be skipped.

Example: false
billsPayableAccountobject(ApiChartAccountListReadDto)

Bills payable account details. See ApiChartAccountListReadDto.

policyAccountobject(ApiChartAccountListReadDto)

Policy account details. See ApiChartAccountListReadDto.

payerCustomerCodestring

Customer code of the payer.

Example: "1002A"
internalReferencestring

Internal bank reference.

Example: "BANKREF123"
mnemostring

Mnemonic code for the bank.

Example: "MNEMO"
sepaTxtWithoutInstructionIdentificationboolean

Indicates if SEPA TXT will be created without instruction identification.

Example: false
confirmingFormatstring(ApiConfirmingFormatEnum)

Format for confirming operations. See ApiConfirmingFormat enum.

Enum"BANKINTER""BBVA""BBVA_EUROCONFIRMING""CAIXABANK""CAIXA_GALICIA""CAJAMAR""SABADELL""SANTANDER""SANTANDER_5_4"
Example: "NORMA_58"
lastPromissoryNoteNumberinteger(int32)

Last promissory note number.

Example: 145
remittanceGenerationCsb34boolean

Indicates if CSB34 remittance generation is enabled.

Example: false
confirmingEmailTransferboolean

Indicates if confirming email transfer is enabled.

Example: true
picturestring

URL or file name of the bank's picture.

Example: "bank_logo.png"
pictureTokenstring

Token related to the bank's picture.

Example: "token-1f8e"
balancenumber

Bank balance.

Example: 15400.8
incomenumber

Bank income amount.

Example: 9671.22
expensesnumber

Bank expenses amount.

Example: 5400.13
synchronizableboolean

Indicates if the bank is synchronizable.

Example: false
showSummaryboolean

Indicates if the summary should be shown.

Example: true
Response
application/json
{
  "id": 1,
  "code": "ES1234",
  "name": "CLAVEI BANK",
  "iban": "ES9820385778983000760236",
  "swift": "BSABESBBXXX",
  "inactive": false,
  "observations": "Merges with main branch yearly",
  "riskGranted": 25000,
  "riskConsumed": 13000.55,
  "riskAvailable": 12000,
  "accountingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "remittancePresenterSuffix": "0001",
  "reportPrtryInsteadCd": false,
  "skipBicorbeiTags": false,
  "skipIndividualData": false,
  "billsPayableAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "policyAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "payerCustomerCode": "1002A",
  "internalReference": "BANKREF123",
  "mnemo": "MNEMO",
  "sepaTxtWithoutInstructionIdentification": false,
  "confirmingFormat": "BANKINTER",
  "lastPromissoryNoteNumber": 145,
  "remittanceGenerationCsb34": false,
  "confirmingEmailTransfer": true,
  "picture": "bank_logo.png",
  "pictureToken": "token-1f8e",
  "balance": 15400.8,
  "income": 9671.22,
  "expenses": 5400.13,
  "synchronizable": false,
  "showSummary": true
}

Update Bank

Request

Update a specific bank.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
codestring[ 0 .. 10 ] charactersrequired

Unique code for the bank.

Example: "ES1234"
namestring[ 0 .. 100 ] charactersrequired

Name of the bank.

Example: "CLAVEI BANK"
ibanstring[ 0 .. 50 ] characters

Bank account IBAN.

Example: "ES9820385778983000760236"
swiftstring[ 0 .. 20 ] characters

SWIFT/BIC code.

Example: "BSABESBBXXX"
inactiveboolean

Indicates if the bank is inactive.

Example: false
observationsstring

Observations about the bank.

Example: "Main office 2025"
riskGrantednumber

Granted risk limit for the bank.

Example: 25000
riskConsumednumber

Consumed risk for the bank.

Example: 13000.55
riskAvailablenumber

Available risk for the bank.

Example: 12000
accountingAccountinteger(int32)

Identifier for the accounting account.

Example: 5720001001
remittancePresenterSuffixstring[ 0 .. 5 ] characters

Remittance presenter suffix.

Example: "0001"
reportPrtryInsteadCdboolean

Indicates if Prtry should be reported instead of Cd.

Example: false
skipBicorbeiTagsboolean

Indicates if BIC/ORBEI tags will be skipped.

Example: false
skipIndividualDataboolean

Indicates if individual data will be skipped.

Example: false
billsPayableAccountinteger(int32)

Bills payable account identifier.

Example: 400001
policyAccountinteger(int32)

Policy account identifier.

Example: 800002
payerCustomerCodestring[ 0 .. 20 ] characters

Payer customer code.

Example: "1002A"
internalReferencestring[ 0 .. 20 ] characters

Internal bank reference.

Example: "BANKREF123"
mnemostring[ 0 .. 10 ] characters

Mnemonic code for the bank.

Example: "MNEMO"
sepaTxtWithoutInstructionIdentificationboolean

Indicates if SEPA TXT will be created without instruction identification.

Example: false
confirmingFormatstring(ApiConfirmingFormatEnum)

Format for confirming operations. See ApiConfirmingFormat enum.

Enum"BANKINTER""BBVA""BBVA_EUROCONFIRMING""CAIXABANK""CAIXA_GALICIA""CAJAMAR""SABADELL""SANTANDER""SANTANDER_5_4"
Example: "NORMA_58"
lastPromissoryNoteNumberinteger(int32)

Last promissory note number.

Example: 145
remittanceGenerationCsb34boolean

Indicates if CSB34 remittance generation is enabled.

Example: false
confirmingEmailTransferboolean

Indicates if confirming email transfer is enabled.

Example: true
picturestring

URL or file name of the bank's picture.

Example: "bank_logo.png"
synchronizableboolean

Indicates if the bank is synchronizable.

Example: false
showSummaryboolean

Indicates if the summary should be shown.

Example: true
curl -i -X PUT \
  'https://api.prana.software/api/v1/bank/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "ES1234",
    "name": "CLAVEI BANK",
    "iban": "ES9820385778983000760236",
    "swift": "BSABESBBXXX",
    "inactive": false,
    "observations": "Main office 2025",
    "riskGranted": 25000,
    "riskConsumed": 13000.55,
    "riskAvailable": 12000,
    "accountingAccount": 5720001001,
    "remittancePresenterSuffix": "0001",
    "reportPrtryInsteadCd": false,
    "skipBicorbeiTags": false,
    "skipIndividualData": false,
    "billsPayableAccount": 400001,
    "policyAccount": 800002,
    "payerCustomerCode": "1002A",
    "internalReference": "BANKREF123",
    "mnemo": "MNEMO",
    "sepaTxtWithoutInstructionIdentification": false,
    "confirmingFormat": "BANKINTER",
    "lastPromissoryNoteNumber": 145,
    "remittanceGenerationCsb34": false,
    "confirmingEmailTransfer": true,
    "picture": "bank_logo.png",
    "synchronizable": false,
    "showSummary": true
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Unique code for the bank.

Example: "ES1234"
namestringrequired

Name of the bank.

Example: "CLAVEI BANK"
ibanstring

IBAN of the bank account.

Example: "ES9820385778983000760236"
swiftstring

SWIFT/BIC code.

Example: "BSABESBBXXX"
inactiveboolean

Indicates if the bank is inactive.

Example: false
observationsstring

Observations about the bank.

Example: "Merges with main branch yearly"
riskGrantednumber

Granted risk limit for the bank.

Example: 25000
riskConsumednumber

Consumed risk for the bank.

Example: 13000.55
riskAvailablenumber

Available risk for the bank.

Example: 12000
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account details. See ApiChartAccountListReadDto.

remittancePresenterSuffixstring

Suffix for the remittance presenter.

Example: "0001"
reportPrtryInsteadCdboolean

Indicates if Prtry should be reported instead of Cd.

Example: false
skipBicorbeiTagsboolean

Indicates if BIC/ORBEI tags will be skipped.

Example: false
skipIndividualDataboolean

Indicates if individual data will be skipped.

Example: false
billsPayableAccountobject(ApiChartAccountListReadDto)

Bills payable account details. See ApiChartAccountListReadDto.

policyAccountobject(ApiChartAccountListReadDto)

Policy account details. See ApiChartAccountListReadDto.

payerCustomerCodestring

Customer code of the payer.

Example: "1002A"
internalReferencestring

Internal bank reference.

Example: "BANKREF123"
mnemostring

Mnemonic code for the bank.

Example: "MNEMO"
sepaTxtWithoutInstructionIdentificationboolean

Indicates if SEPA TXT will be created without instruction identification.

Example: false
confirmingFormatstring(ApiConfirmingFormatEnum)

Format for confirming operations. See ApiConfirmingFormat enum.

Enum"BANKINTER""BBVA""BBVA_EUROCONFIRMING""CAIXABANK""CAIXA_GALICIA""CAJAMAR""SABADELL""SANTANDER""SANTANDER_5_4"
Example: "NORMA_58"
lastPromissoryNoteNumberinteger(int32)

Last promissory note number.

Example: 145
remittanceGenerationCsb34boolean

Indicates if CSB34 remittance generation is enabled.

Example: false
confirmingEmailTransferboolean

Indicates if confirming email transfer is enabled.

Example: true
picturestring

URL or file name of the bank's picture.

Example: "bank_logo.png"
pictureTokenstring

Token related to the bank's picture.

Example: "token-1f8e"
balancenumber

Bank balance.

Example: 15400.8
incomenumber

Bank income amount.

Example: 9671.22
expensesnumber

Bank expenses amount.

Example: 5400.13
synchronizableboolean

Indicates if the bank is synchronizable.

Example: false
showSummaryboolean

Indicates if the summary should be shown.

Example: true
Response
application/json
{
  "id": 1,
  "code": "ES1234",
  "name": "CLAVEI BANK",
  "iban": "ES9820385778983000760236",
  "swift": "BSABESBBXXX",
  "inactive": false,
  "observations": "Merges with main branch yearly",
  "riskGranted": 25000,
  "riskConsumed": 13000.55,
  "riskAvailable": 12000,
  "accountingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "remittancePresenterSuffix": "0001",
  "reportPrtryInsteadCd": false,
  "skipBicorbeiTags": false,
  "skipIndividualData": false,
  "billsPayableAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "policyAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "payerCustomerCode": "1002A",
  "internalReference": "BANKREF123",
  "mnemo": "MNEMO",
  "sepaTxtWithoutInstructionIdentification": false,
  "confirmingFormat": "BANKINTER",
  "lastPromissoryNoteNumber": 145,
  "remittanceGenerationCsb34": false,
  "confirmingEmailTransfer": true,
  "picture": "bank_logo.png",
  "pictureToken": "token-1f8e",
  "balance": 15400.8,
  "income": 9671.22,
  "expenses": 5400.13,
  "synchronizable": false,
  "showSummary": true
}

Delete Bank

Request

Delete specific bank.

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

Responses

OK

Patch Bank

Request

Patch specific Bank.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Unique code for the bank.

Example: "ES1234"
namestringrequired

Name of the bank.

Example: "CLAVEI BANK"
ibanstring

IBAN of the bank account.

Example: "ES9820385778983000760236"
swiftstring

SWIFT/BIC code.

Example: "BSABESBBXXX"
inactiveboolean

Indicates if the bank is inactive.

Example: false
observationsstring

Observations about the bank.

Example: "Merges with main branch yearly"
riskGrantednumber

Granted risk limit for the bank.

Example: 25000
riskConsumednumber

Consumed risk for the bank.

Example: 13000.55
riskAvailablenumber

Available risk for the bank.

Example: 12000
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account details. See ApiChartAccountListReadDto.

remittancePresenterSuffixstring

Suffix for the remittance presenter.

Example: "0001"
reportPrtryInsteadCdboolean

Indicates if Prtry should be reported instead of Cd.

Example: false
skipBicorbeiTagsboolean

Indicates if BIC/ORBEI tags will be skipped.

Example: false
skipIndividualDataboolean

Indicates if individual data will be skipped.

Example: false
billsPayableAccountobject(ApiChartAccountListReadDto)

Bills payable account details. See ApiChartAccountListReadDto.

policyAccountobject(ApiChartAccountListReadDto)

Policy account details. See ApiChartAccountListReadDto.

payerCustomerCodestring

Customer code of the payer.

Example: "1002A"
internalReferencestring

Internal bank reference.

Example: "BANKREF123"
mnemostring

Mnemonic code for the bank.

Example: "MNEMO"
sepaTxtWithoutInstructionIdentificationboolean

Indicates if SEPA TXT will be created without instruction identification.

Example: false
confirmingFormatstring(ApiConfirmingFormatEnum)

Format for confirming operations. See ApiConfirmingFormat enum.

Enum"BANKINTER""BBVA""BBVA_EUROCONFIRMING""CAIXABANK""CAIXA_GALICIA""CAJAMAR""SABADELL""SANTANDER""SANTANDER_5_4"
Example: "NORMA_58"
lastPromissoryNoteNumberinteger(int32)

Last promissory note number.

Example: 145
remittanceGenerationCsb34boolean

Indicates if CSB34 remittance generation is enabled.

Example: false
confirmingEmailTransferboolean

Indicates if confirming email transfer is enabled.

Example: true
picturestring

URL or file name of the bank's picture.

Example: "bank_logo.png"
pictureTokenstring

Token related to the bank's picture.

Example: "token-1f8e"
balancenumber

Bank balance.

Example: 15400.8
incomenumber

Bank income amount.

Example: 9671.22
expensesnumber

Bank expenses amount.

Example: 5400.13
synchronizableboolean

Indicates if the bank is synchronizable.

Example: false
showSummaryboolean

Indicates if the summary should be shown.

Example: true
Response
application/json
{
  "id": 1,
  "code": "ES1234",
  "name": "CLAVEI BANK",
  "iban": "ES9820385778983000760236",
  "swift": "BSABESBBXXX",
  "inactive": false,
  "observations": "Merges with main branch yearly",
  "riskGranted": 25000,
  "riskConsumed": 13000.55,
  "riskAvailable": 12000,
  "accountingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "remittancePresenterSuffix": "0001",
  "reportPrtryInsteadCd": false,
  "skipBicorbeiTags": false,
  "skipIndividualData": false,
  "billsPayableAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "policyAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "payerCustomerCode": "1002A",
  "internalReference": "BANKREF123",
  "mnemo": "MNEMO",
  "sepaTxtWithoutInstructionIdentification": false,
  "confirmingFormat": "BANKINTER",
  "lastPromissoryNoteNumber": 145,
  "remittanceGenerationCsb34": false,
  "confirmingEmailTransfer": true,
  "picture": "bank_logo.png",
  "pictureToken": "token-1f8e",
  "balance": 15400.8,
  "income": 9671.22,
  "expenses": 5400.13,
  "synchronizable": false,
  "showSummary": true
}

Create Bank

Request

Create a new bank.

Bodyapplication/jsonrequired
codestring[ 0 .. 10 ] charactersrequired

Unique code for the bank.

Example: "ES1234"
namestring[ 0 .. 100 ] charactersrequired

Name of the bank.

Example: "CLAVEI BANK"
ibanstring[ 0 .. 50 ] characters

Bank account IBAN.

Example: "ES9820385778983000760236"
swiftstring[ 0 .. 20 ] characters

SWIFT/BIC code.

Example: "BSABESBBXXX"
inactiveboolean

Indicates if the bank is inactive.

Example: false
observationsstring

Observations about the bank.

Example: "Main office 2025"
riskGrantednumber

Granted risk limit for the bank.

Example: 25000
riskConsumednumber

Consumed risk for the bank.

Example: 13000.55
riskAvailablenumber

Available risk for the bank.

Example: 12000
accountingAccountinteger(int32)

Identifier for the accounting account.

Example: 5720001001
remittancePresenterSuffixstring[ 0 .. 5 ] characters

Remittance presenter suffix.

Example: "0001"
reportPrtryInsteadCdboolean

Indicates if Prtry should be reported instead of Cd.

Example: false
skipBicorbeiTagsboolean

Indicates if BIC/ORBEI tags will be skipped.

Example: false
skipIndividualDataboolean

Indicates if individual data will be skipped.

Example: false
billsPayableAccountinteger(int32)

Bills payable account identifier.

Example: 400001
policyAccountinteger(int32)

Policy account identifier.

Example: 800002
payerCustomerCodestring[ 0 .. 20 ] characters

Payer customer code.

Example: "1002A"
internalReferencestring[ 0 .. 20 ] characters

Internal bank reference.

Example: "BANKREF123"
mnemostring[ 0 .. 10 ] characters

Mnemonic code for the bank.

Example: "MNEMO"
sepaTxtWithoutInstructionIdentificationboolean

Indicates if SEPA TXT will be created without instruction identification.

Example: false
confirmingFormatstring(ApiConfirmingFormatEnum)

Format for confirming operations. See ApiConfirmingFormat enum.

Enum"BANKINTER""BBVA""BBVA_EUROCONFIRMING""CAIXABANK""CAIXA_GALICIA""CAJAMAR""SABADELL""SANTANDER""SANTANDER_5_4"
Example: "NORMA_58"
lastPromissoryNoteNumberinteger(int32)

Last promissory note number.

Example: 145
remittanceGenerationCsb34boolean

Indicates if CSB34 remittance generation is enabled.

Example: false
confirmingEmailTransferboolean

Indicates if confirming email transfer is enabled.

Example: true
picturestring

URL or file name of the bank's picture.

Example: "bank_logo.png"
synchronizableboolean

Indicates if the bank is synchronizable.

Example: false
showSummaryboolean

Indicates if the summary should be shown.

Example: true
curl -i -X POST \
  https://api.prana.software/api/v1/bank \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "ES1234",
    "name": "CLAVEI BANK",
    "iban": "ES9820385778983000760236",
    "swift": "BSABESBBXXX",
    "inactive": false,
    "observations": "Main office 2025",
    "riskGranted": 25000,
    "riskConsumed": 13000.55,
    "riskAvailable": 12000,
    "accountingAccount": 5720001001,
    "remittancePresenterSuffix": "0001",
    "reportPrtryInsteadCd": false,
    "skipBicorbeiTags": false,
    "skipIndividualData": false,
    "billsPayableAccount": 400001,
    "policyAccount": 800002,
    "payerCustomerCode": "1002A",
    "internalReference": "BANKREF123",
    "mnemo": "MNEMO",
    "sepaTxtWithoutInstructionIdentification": false,
    "confirmingFormat": "BANKINTER",
    "lastPromissoryNoteNumber": 145,
    "remittanceGenerationCsb34": false,
    "confirmingEmailTransfer": true,
    "picture": "bank_logo.png",
    "synchronizable": false,
    "showSummary": true
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codestringrequired

Unique code for the bank.

Example: "ES1234"
namestringrequired

Name of the bank.

Example: "CLAVEI BANK"
ibanstring

IBAN of the bank account.

Example: "ES9820385778983000760236"
swiftstring

SWIFT/BIC code.

Example: "BSABESBBXXX"
inactiveboolean

Indicates if the bank is inactive.

Example: false
observationsstring

Observations about the bank.

Example: "Merges with main branch yearly"
riskGrantednumber

Granted risk limit for the bank.

Example: 25000
riskConsumednumber

Consumed risk for the bank.

Example: 13000.55
riskAvailablenumber

Available risk for the bank.

Example: 12000
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account details. See ApiChartAccountListReadDto.

remittancePresenterSuffixstring

Suffix for the remittance presenter.

Example: "0001"
reportPrtryInsteadCdboolean

Indicates if Prtry should be reported instead of Cd.

Example: false
skipBicorbeiTagsboolean

Indicates if BIC/ORBEI tags will be skipped.

Example: false
skipIndividualDataboolean

Indicates if individual data will be skipped.

Example: false
billsPayableAccountobject(ApiChartAccountListReadDto)

Bills payable account details. See ApiChartAccountListReadDto.

policyAccountobject(ApiChartAccountListReadDto)

Policy account details. See ApiChartAccountListReadDto.

payerCustomerCodestring

Customer code of the payer.

Example: "1002A"
internalReferencestring

Internal bank reference.

Example: "BANKREF123"
mnemostring

Mnemonic code for the bank.

Example: "MNEMO"
sepaTxtWithoutInstructionIdentificationboolean

Indicates if SEPA TXT will be created without instruction identification.

Example: false
confirmingFormatstring(ApiConfirmingFormatEnum)

Format for confirming operations. See ApiConfirmingFormat enum.

Enum"BANKINTER""BBVA""BBVA_EUROCONFIRMING""CAIXABANK""CAIXA_GALICIA""CAJAMAR""SABADELL""SANTANDER""SANTANDER_5_4"
Example: "NORMA_58"
lastPromissoryNoteNumberinteger(int32)

Last promissory note number.

Example: 145
remittanceGenerationCsb34boolean

Indicates if CSB34 remittance generation is enabled.

Example: false
confirmingEmailTransferboolean

Indicates if confirming email transfer is enabled.

Example: true
picturestring

URL or file name of the bank's picture.

Example: "bank_logo.png"
pictureTokenstring

Token related to the bank's picture.

Example: "token-1f8e"
balancenumber

Bank balance.

Example: 15400.8
incomenumber

Bank income amount.

Example: 9671.22
expensesnumber

Bank expenses amount.

Example: 5400.13
synchronizableboolean

Indicates if the bank is synchronizable.

Example: false
showSummaryboolean

Indicates if the summary should be shown.

Example: true
Response
application/json
{
  "id": 1,
  "code": "ES1234",
  "name": "CLAVEI BANK",
  "iban": "ES9820385778983000760236",
  "swift": "BSABESBBXXX",
  "inactive": false,
  "observations": "Merges with main branch yearly",
  "riskGranted": 25000,
  "riskConsumed": 13000.55,
  "riskAvailable": 12000,
  "accountingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "remittancePresenterSuffix": "0001",
  "reportPrtryInsteadCd": false,
  "skipBicorbeiTags": false,
  "skipIndividualData": false,
  "billsPayableAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "policyAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "payerCustomerCode": "1002A",
  "internalReference": "BANKREF123",
  "mnemo": "MNEMO",
  "sepaTxtWithoutInstructionIdentification": false,
  "confirmingFormat": "BANKINTER",
  "lastPromissoryNoteNumber": 145,
  "remittanceGenerationCsb34": false,
  "confirmingEmailTransfer": true,
  "picture": "bank_logo.png",
  "pictureToken": "token-1f8e",
  "balance": 15400.8,
  "income": 9671.22,
  "expenses": 5400.13,
  "synchronizable": false,
  "showSummary": true
}

List Banks

Request

Get all your banks.

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/bank/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(ApiBankListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​codestringrequired

Unique code for the bank.

Example: "ES1234"
data[].​namestringrequired

Bank name.

Example: "CLAVEI BANK"
data[].​ibanstring

IBAN account code.

Example: "ES9820385778983000760236"
data[].​swiftstring

SWIFT/BIC code.

Example: "BSABESBBXXX"
data[].​inactiveboolean

Indicates if the bank is inactive.

Example: false
data[].​riskGrantednumber

Granted risk limit for the bank.

Example: 25000
data[].​riskConsumednumber

Consumed risk for the bank.

Example: 13000.55
data[].​accountingAccountstring

Accounting account reference.

Example: 5720001234
data[].​policyAccountstring

Policy account reference.

Example: 5720009999
data[].​picturestring

URL or name of the main picture.

Example: "bank_logo.png"
data[].​pictureTokenstring

Security token for picture.

Example: "1f8e3ac9d89d"
data[].​defaultBankboolean

Indicates if this is the default bank.

Example: true
data[].​balancenumber

Bank balance value.

Example: 15400.8
data[].​incomenumber

Bank income amount.

Example: 9671.22
data[].​expensesnumber

Bank expenses amount.

Example: 5400.13
data[].​lastConciliationDatestring(date-time)

Date of the last conciliation.

Example: "2025-01-15T10:30:00Z"
data[].​synchronizableboolean

Indicates if the bank is synchronizable.

Example: false
data[].​showSummaryboolean

Indicates if the summary should be shown.

Example: true
data[].​tokenstring

Token value related to the bank.

Example: "token-885b"
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
}

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

webhook-controller

Operations

api-ecommerce-controller

Operations