Skip to content

Prana API (1.0)

API Definition to interact with Prana platform

Download OpenAPI description
openapi.json
openapi.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

Supplier

Manage your Suppliers

Operations

Get Supplier

Request

Get a specific supplier.

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

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codeinteger(int32)
cifstring
commercialNamestring
vatobject(ApiCustomerVatTypeListReadDto)
namestring
addressstring
countryobject(ApiCountryListReadDto)
stateobject(ApiStateListReadDto)
postalCodestring
citystring
phone1string
phone2string
replacementTimenumber
languageobject(ApiLanguageListReadDto)
currencyobject(ApiCurrencyListReadDto)
manufacturerboolean
importerboolean
activeboolean
notCreateOrderboolean
observationstring
geographicalLocationstring(ApiGeographicalLocationEnum)
Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
creationDatestring(date)
inactiveDatestring(date)
accountingAccountobject(ApiChartAccountListReadDto)
customerobject(ApiCustomerListReadDto)
operatorobject(ApiOperatorReadDto)
warehouseobject(ApiWarehouseListReadDto)
emailstring
paymentMethodobject(ApiPaymentMethodListReadDto)
termsinteger(int32)
daysFirstTerminteger(int32)
daysBetweenTermsinteger(int32)
discount1number
discount2number
discountPpnumber
proximityTypestring(ApiProximityTypeEnum)
Enum"NEARBY""PREVIOUS""LATER"
paymentDay1integer(int32)
paymentDay2integer(int32)
paymentDay3integer(int32)
weekdaystring(ApiWeekDayEnum)
Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
paymentMethodObservationobject(ApiObservationListReadDto)
paymentMethodObservationDescriptionstring[ 0 .. 255 ] characters
accountstring[ 0 .. 50 ] characters
swiftstring[ 0 .. 20 ] characters
bicstring[ 0 .. 20 ] characters
agencyobject(ApiAgencyListReadDto)
shippingTermobject(ApiShippingTermListReadDto)
ropoCodestring
ropoExpireDatestring(date)
tagsArray of strings
irpfTypestring(ApiIRPFTypeEnum)
Enum"LEASES""PROFESIONAL_ACTIVITIES""AGRO"
bankNamestring
contactPersonstring
picturestring
pictureTokenstring
incomeTaxRatenumber
webstring
modifiedOnstring(date-time)
observationsArray of objects(ApiCustomerObservationListReadDto)
filesArray of objects(ApiCustomerFileListReadDto)
Response
application/json
{
  "id": 1,
  "code": 0,
  "cif": "string",
  "commercialName": "string",
  "vat": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "name": "string",
  "address": "string",
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "state": {
    "id": 1,
    "code": "string",
    "description": "string",
    "country": { … },
    "isoCode": "string"
  },
  "postalCode": "string",
  "city": "string",
  "phone1": "string",
  "phone2": "string",
  "replacementTime": 0,
  "language": {
    "id": 1,
    "code": "ES",
    "description": "Spanish",
    "isoCode": "EN"
  },
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "manufacturer": true,
  "importer": true,
  "active": true,
  "notCreateOrder": true,
  "observation": "string",
  "geographicalLocation": "NATIONAL",
  "creationDate": "2019-08-24",
  "inactiveDate": "2019-08-24",
  "accountingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "customer": {
    "id": 10001,
    "code": 10001,
    "name": "Acme S.A.",
    "commercialName": "Acme España",
    "cif": "B12345678",
    "address": "Av. de la Estación, 5",
    "firstPhoneNumber": "+34600111222",
    "secondPhoneNumber": "+34600333444",
    "postalCode": "03001",
    "countryDescription": "Spain",
    "stateDescription": "Alicante",
    "email": "info@acme.es",
    "city": "Alicante",
    "activity": "Wholesale Trade",
    "brand": "Acme",
    "brandId": 100,
    "creationDate": "2020-01-01",
    "isActive": true,
    "inactiveDate": "2023-08-07",
    "paymentMethodId": 1,
    "paymentMethod": "Bank Transfer",
    "paymentMethodServeFullPrePaid": false,
    "rateCode": "RATE-001",
    "account": "ES9820385778983000760236",
    "vatDescription": "General",
    "discount1": 5,
    "currencyCode": "EUR",
    "currencyDescription": "Euro",
    "modifiedOn": "2024-08-07T12:30:00",
    "bankName": "Santander",
    "contactPerson": "Juan Pérez",
    "web": "https://www.acme.es",
    "picture": "https://www.acme.es/logo.png",
    "pictureToken": "xyz-token-241235",
    "tags": [ … ]
  },
  "operator": {
    "id": 1,
    "code": 0,
    "name": "string"
  },
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse"
  },
  "email": "string",
  "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"
  },
  "terms": 0,
  "daysFirstTerm": 0,
  "daysBetweenTerms": 0,
  "discount1": 0,
  "discount2": 0,
  "discountPp": 0,
  "proximityType": "NEARBY",
  "paymentDay1": 0,
  "paymentDay2": 0,
  "paymentDay3": 0,
  "weekday": "MONDAY",
  "paymentMethodObservation": {
    "id": 1,
    "code": "string",
    "type": "CLASSIFICATION",
    "description": "string",
    "blockOrder": true
  },
  "paymentMethodObservationDescription": "string",
  "account": "string",
  "swift": "string",
  "bic": "string",
  "agency": {
    "id": 1,
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "shippingTerm": {
    "id": 1,
    "code": "string",
    "customerPays": true,
    "intrastatCode": "string"
  },
  "ropoCode": "string",
  "ropoExpireDate": "2019-08-24",
  "tags": [
    "string"
  ],
  "irpfType": "LEASES",
  "bankName": "string",
  "contactPerson": "string",
  "picture": "string",
  "pictureToken": "string",
  "incomeTaxRate": 0,
  "web": "string",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "observations": [
    { … }
  ],
  "files": [
    { … }
  ]
}

Update Supplier

Request

Update a specific supplier.

Path
idinteger(int32)required
Bodyapplication/jsonrequired
codeinteger(int32)
cifstring[ 0 .. 20 ] characters
commercialNamestring[ 0 .. 100 ] charactersrequired
namestring[ 0 .. 100 ] characters
addressstring[ 0 .. 100 ] characters
countryinteger(int32)
vatinteger(int32)
stateinteger(int32)
postalCodestring[ 0 .. 10 ] characters
citystring[ 0 .. 100 ] characters
phone1string[ 0 .. 20 ] characters
phone2string[ 0 .. 20 ] characters
replacementTimenumber
languageinteger(int32)
currencyinteger(int32)
manufacturerboolean
importerboolean
activeboolean
notCreateOrderboolean
observationstring
geographicalLocationstring(ApiGeographicalLocationEnum)
Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
creationDatestring(date)
inactiveDatestring(date)
accountingAccountinteger(int32)
customerinteger(int32)
operatorinteger(int32)
warehouseinteger(int32)
emailstring[ 0 .. 250 ] characters
paymentMethodinteger(int32)required
termsinteger(int32)
daysFirstTerminteger(int32)
daysBetweenTermsinteger(int32)
discount1number
discount2number
discountPpnumber
proximityTypestring(ApiProximityTypeEnum)
Enum"NEARBY""PREVIOUS""LATER"
paymentDay1integer(int32)
paymentDay2integer(int32)
paymentDay3integer(int32)
weekdaystring(ApiWeekDayEnum)
Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
paymentMethodObservationinteger(int32)
paymentMethodObservationDescriptionstring
accountstring[ 0 .. 50 ] characters
swiftstring[ 0 .. 20 ] characters
bicstring[ 0 .. 20 ] characters
agencyinteger(int32)
shippingTerminteger(int32)
ropoCodestring
ropoExpireDatestring(date)
irpfTypestring(ApiIRPFTypeEnum)
Enum"LEASES""PROFESIONAL_ACTIVITIES""AGRO"
picturestring
bankNamestring
contactPersonstring
incomeTaxRatenumber
webstring
tagsArray of strings
observationsArray of objects(ApiSupplierObservationWriteDto)
filesArray of objects(ApiSupplierFileWriteDto)
curl -i -X PUT \
  'https://api.prana.software/api/v1/supplier/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": 0,
    "cif": "string",
    "commercialName": "string",
    "name": "string",
    "address": "string",
    "country": 0,
    "vat": 0,
    "state": 0,
    "postalCode": "string",
    "city": "string",
    "phone1": "string",
    "phone2": "string",
    "replacementTime": 0,
    "language": 0,
    "currency": 0,
    "manufacturer": true,
    "importer": true,
    "active": true,
    "notCreateOrder": true,
    "observation": "string",
    "geographicalLocation": "NATIONAL",
    "creationDate": "2019-08-24",
    "inactiveDate": "2019-08-24",
    "accountingAccount": 0,
    "customer": 0,
    "operator": 0,
    "warehouse": 0,
    "email": "string",
    "paymentMethod": 0,
    "terms": 0,
    "daysFirstTerm": 0,
    "daysBetweenTerms": 0,
    "discount1": 0,
    "discount2": 0,
    "discountPp": 0,
    "proximityType": "NEARBY",
    "paymentDay1": 0,
    "paymentDay2": 0,
    "paymentDay3": 0,
    "weekday": "MONDAY",
    "paymentMethodObservation": 0,
    "paymentMethodObservationDescription": "string",
    "account": "string",
    "swift": "string",
    "bic": "string",
    "agency": 0,
    "shippingTerm": 0,
    "ropoCode": "string",
    "ropoExpireDate": "2019-08-24",
    "irpfType": "LEASES",
    "picture": "string",
    "bankName": "string",
    "contactPerson": "string",
    "incomeTaxRate": 0,
    "web": "string",
    "tags": [
      "string"
    ],
    "observations": [
      {
        "id": 0,
        "title": "string",
        "description": "string"
      }
    ],
    "files": [
      {
        "id": 0,
        "token": "string",
        "fileName": "string",
        "fileExtension": "string",
        "fileSize": 0
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codeinteger(int32)
cifstring
commercialNamestring
vatobject(ApiCustomerVatTypeListReadDto)
namestring
addressstring
countryobject(ApiCountryListReadDto)
stateobject(ApiStateListReadDto)
postalCodestring
citystring
phone1string
phone2string
replacementTimenumber
languageobject(ApiLanguageListReadDto)
currencyobject(ApiCurrencyListReadDto)
manufacturerboolean
importerboolean
activeboolean
notCreateOrderboolean
observationstring
geographicalLocationstring(ApiGeographicalLocationEnum)
Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
creationDatestring(date)
inactiveDatestring(date)
accountingAccountobject(ApiChartAccountListReadDto)
customerobject(ApiCustomerListReadDto)
operatorobject(ApiOperatorReadDto)
warehouseobject(ApiWarehouseListReadDto)
emailstring
paymentMethodobject(ApiPaymentMethodListReadDto)
termsinteger(int32)
daysFirstTerminteger(int32)
daysBetweenTermsinteger(int32)
discount1number
discount2number
discountPpnumber
proximityTypestring(ApiProximityTypeEnum)
Enum"NEARBY""PREVIOUS""LATER"
paymentDay1integer(int32)
paymentDay2integer(int32)
paymentDay3integer(int32)
weekdaystring(ApiWeekDayEnum)
Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
paymentMethodObservationobject(ApiObservationListReadDto)
paymentMethodObservationDescriptionstring[ 0 .. 255 ] characters
accountstring[ 0 .. 50 ] characters
swiftstring[ 0 .. 20 ] characters
bicstring[ 0 .. 20 ] characters
agencyobject(ApiAgencyListReadDto)
shippingTermobject(ApiShippingTermListReadDto)
ropoCodestring
ropoExpireDatestring(date)
tagsArray of strings
irpfTypestring(ApiIRPFTypeEnum)
Enum"LEASES""PROFESIONAL_ACTIVITIES""AGRO"
bankNamestring
contactPersonstring
picturestring
pictureTokenstring
incomeTaxRatenumber
webstring
modifiedOnstring(date-time)
observationsArray of objects(ApiCustomerObservationListReadDto)
filesArray of objects(ApiCustomerFileListReadDto)
Response
application/json
{
  "id": 1,
  "code": 0,
  "cif": "string",
  "commercialName": "string",
  "vat": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "name": "string",
  "address": "string",
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "state": {
    "id": 1,
    "code": "string",
    "description": "string",
    "country": { … },
    "isoCode": "string"
  },
  "postalCode": "string",
  "city": "string",
  "phone1": "string",
  "phone2": "string",
  "replacementTime": 0,
  "language": {
    "id": 1,
    "code": "ES",
    "description": "Spanish",
    "isoCode": "EN"
  },
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "manufacturer": true,
  "importer": true,
  "active": true,
  "notCreateOrder": true,
  "observation": "string",
  "geographicalLocation": "NATIONAL",
  "creationDate": "2019-08-24",
  "inactiveDate": "2019-08-24",
  "accountingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "customer": {
    "id": 10001,
    "code": 10001,
    "name": "Acme S.A.",
    "commercialName": "Acme España",
    "cif": "B12345678",
    "address": "Av. de la Estación, 5",
    "firstPhoneNumber": "+34600111222",
    "secondPhoneNumber": "+34600333444",
    "postalCode": "03001",
    "countryDescription": "Spain",
    "stateDescription": "Alicante",
    "email": "info@acme.es",
    "city": "Alicante",
    "activity": "Wholesale Trade",
    "brand": "Acme",
    "brandId": 100,
    "creationDate": "2020-01-01",
    "isActive": true,
    "inactiveDate": "2023-08-07",
    "paymentMethodId": 1,
    "paymentMethod": "Bank Transfer",
    "paymentMethodServeFullPrePaid": false,
    "rateCode": "RATE-001",
    "account": "ES9820385778983000760236",
    "vatDescription": "General",
    "discount1": 5,
    "currencyCode": "EUR",
    "currencyDescription": "Euro",
    "modifiedOn": "2024-08-07T12:30:00",
    "bankName": "Santander",
    "contactPerson": "Juan Pérez",
    "web": "https://www.acme.es",
    "picture": "https://www.acme.es/logo.png",
    "pictureToken": "xyz-token-241235",
    "tags": [ … ]
  },
  "operator": {
    "id": 1,
    "code": 0,
    "name": "string"
  },
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse"
  },
  "email": "string",
  "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"
  },
  "terms": 0,
  "daysFirstTerm": 0,
  "daysBetweenTerms": 0,
  "discount1": 0,
  "discount2": 0,
  "discountPp": 0,
  "proximityType": "NEARBY",
  "paymentDay1": 0,
  "paymentDay2": 0,
  "paymentDay3": 0,
  "weekday": "MONDAY",
  "paymentMethodObservation": {
    "id": 1,
    "code": "string",
    "type": "CLASSIFICATION",
    "description": "string",
    "blockOrder": true
  },
  "paymentMethodObservationDescription": "string",
  "account": "string",
  "swift": "string",
  "bic": "string",
  "agency": {
    "id": 1,
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "shippingTerm": {
    "id": 1,
    "code": "string",
    "customerPays": true,
    "intrastatCode": "string"
  },
  "ropoCode": "string",
  "ropoExpireDate": "2019-08-24",
  "tags": [
    "string"
  ],
  "irpfType": "LEASES",
  "bankName": "string",
  "contactPerson": "string",
  "picture": "string",
  "pictureToken": "string",
  "incomeTaxRate": 0,
  "web": "string",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "observations": [
    { … }
  ],
  "files": [
    { … }
  ]
}

Delete Supplier

Request

Delete specific supplier.

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

Responses

OK

Create Supplier

Request

Create a new supplier.

Bodyapplication/jsonrequired
codeinteger(int32)
cifstring[ 0 .. 20 ] characters
commercialNamestring[ 0 .. 100 ] charactersrequired
namestring[ 0 .. 100 ] characters
addressstring[ 0 .. 100 ] characters
countryinteger(int32)
vatinteger(int32)
stateinteger(int32)
postalCodestring[ 0 .. 10 ] characters
citystring[ 0 .. 100 ] characters
phone1string[ 0 .. 20 ] characters
phone2string[ 0 .. 20 ] characters
replacementTimenumber
languageinteger(int32)
currencyinteger(int32)
manufacturerboolean
importerboolean
activeboolean
notCreateOrderboolean
observationstring
geographicalLocationstring(ApiGeographicalLocationEnum)
Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
creationDatestring(date)
inactiveDatestring(date)
accountingAccountinteger(int32)
customerinteger(int32)
operatorinteger(int32)
warehouseinteger(int32)
emailstring[ 0 .. 250 ] characters
paymentMethodinteger(int32)required
termsinteger(int32)
daysFirstTerminteger(int32)
daysBetweenTermsinteger(int32)
discount1number
discount2number
discountPpnumber
proximityTypestring(ApiProximityTypeEnum)
Enum"NEARBY""PREVIOUS""LATER"
paymentDay1integer(int32)
paymentDay2integer(int32)
paymentDay3integer(int32)
weekdaystring(ApiWeekDayEnum)
Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
paymentMethodObservationinteger(int32)
paymentMethodObservationDescriptionstring
accountstring[ 0 .. 50 ] characters
swiftstring[ 0 .. 20 ] characters
bicstring[ 0 .. 20 ] characters
agencyinteger(int32)
shippingTerminteger(int32)
ropoCodestring
ropoExpireDatestring(date)
irpfTypestring(ApiIRPFTypeEnum)
Enum"LEASES""PROFESIONAL_ACTIVITIES""AGRO"
picturestring
bankNamestring
contactPersonstring
incomeTaxRatenumber
webstring
tagsArray of strings
observationsArray of objects(ApiSupplierObservationWriteDto)
filesArray of objects(ApiSupplierFileWriteDto)
curl -i -X POST \
  https://api.prana.software/api/v1/supplier \
  -H 'Content-Type: application/json' \
  -d '{
    "code": 0,
    "cif": "string",
    "commercialName": "string",
    "name": "string",
    "address": "string",
    "country": 0,
    "vat": 0,
    "state": 0,
    "postalCode": "string",
    "city": "string",
    "phone1": "string",
    "phone2": "string",
    "replacementTime": 0,
    "language": 0,
    "currency": 0,
    "manufacturer": true,
    "importer": true,
    "active": true,
    "notCreateOrder": true,
    "observation": "string",
    "geographicalLocation": "NATIONAL",
    "creationDate": "2019-08-24",
    "inactiveDate": "2019-08-24",
    "accountingAccount": 0,
    "customer": 0,
    "operator": 0,
    "warehouse": 0,
    "email": "string",
    "paymentMethod": 0,
    "terms": 0,
    "daysFirstTerm": 0,
    "daysBetweenTerms": 0,
    "discount1": 0,
    "discount2": 0,
    "discountPp": 0,
    "proximityType": "NEARBY",
    "paymentDay1": 0,
    "paymentDay2": 0,
    "paymentDay3": 0,
    "weekday": "MONDAY",
    "paymentMethodObservation": 0,
    "paymentMethodObservationDescription": "string",
    "account": "string",
    "swift": "string",
    "bic": "string",
    "agency": 0,
    "shippingTerm": 0,
    "ropoCode": "string",
    "ropoExpireDate": "2019-08-24",
    "irpfType": "LEASES",
    "picture": "string",
    "bankName": "string",
    "contactPerson": "string",
    "incomeTaxRate": 0,
    "web": "string",
    "tags": [
      "string"
    ],
    "observations": [
      {
        "id": 0,
        "title": "string",
        "description": "string"
      }
    ],
    "files": [
      {
        "id": 0,
        "token": "string",
        "fileName": "string",
        "fileExtension": "string",
        "fileSize": 0
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idinteger(int32)required

Unique identifier of the entity

Example: 1
codeinteger(int32)
cifstring
commercialNamestring
vatobject(ApiCustomerVatTypeListReadDto)
namestring
addressstring
countryobject(ApiCountryListReadDto)
stateobject(ApiStateListReadDto)
postalCodestring
citystring
phone1string
phone2string
replacementTimenumber
languageobject(ApiLanguageListReadDto)
currencyobject(ApiCurrencyListReadDto)
manufacturerboolean
importerboolean
activeboolean
notCreateOrderboolean
observationstring
geographicalLocationstring(ApiGeographicalLocationEnum)
Enum"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
creationDatestring(date)
inactiveDatestring(date)
accountingAccountobject(ApiChartAccountListReadDto)
customerobject(ApiCustomerListReadDto)
operatorobject(ApiOperatorReadDto)
warehouseobject(ApiWarehouseListReadDto)
emailstring
paymentMethodobject(ApiPaymentMethodListReadDto)
termsinteger(int32)
daysFirstTerminteger(int32)
daysBetweenTermsinteger(int32)
discount1number
discount2number
discountPpnumber
proximityTypestring(ApiProximityTypeEnum)
Enum"NEARBY""PREVIOUS""LATER"
paymentDay1integer(int32)
paymentDay2integer(int32)
paymentDay3integer(int32)
weekdaystring(ApiWeekDayEnum)
Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
paymentMethodObservationobject(ApiObservationListReadDto)
paymentMethodObservationDescriptionstring[ 0 .. 255 ] characters
accountstring[ 0 .. 50 ] characters
swiftstring[ 0 .. 20 ] characters
bicstring[ 0 .. 20 ] characters
agencyobject(ApiAgencyListReadDto)
shippingTermobject(ApiShippingTermListReadDto)
ropoCodestring
ropoExpireDatestring(date)
tagsArray of strings
irpfTypestring(ApiIRPFTypeEnum)
Enum"LEASES""PROFESIONAL_ACTIVITIES""AGRO"
bankNamestring
contactPersonstring
picturestring
pictureTokenstring
incomeTaxRatenumber
webstring
modifiedOnstring(date-time)
observationsArray of objects(ApiCustomerObservationListReadDto)
filesArray of objects(ApiCustomerFileListReadDto)
Response
application/json
{
  "id": 1,
  "code": 0,
  "cif": "string",
  "commercialName": "string",
  "vat": {
    "id": 1,
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "name": "string",
  "address": "string",
  "country": {
    "id": 1,
    "code": 724,
    "description": "Spain",
    "isoCode": "US",
    "customerVatType": "GENERAL",
    "geographicalLocation": "NATIONAL"
  },
  "state": {
    "id": 1,
    "code": "string",
    "description": "string",
    "country": { … },
    "isoCode": "string"
  },
  "postalCode": "string",
  "city": "string",
  "phone1": "string",
  "phone2": "string",
  "replacementTime": 0,
  "language": {
    "id": 1,
    "code": "ES",
    "description": "Spanish",
    "isoCode": "EN"
  },
  "currency": {
    "id": 1,
    "code": "strin",
    "description": "string",
    "nomenclature": "strin",
    "isoCode": "USD",
    "changeValue": 0,
    "significantDecimalsDocuments": 0,
    "intermediateDecimalsDocuments": 0,
    "decimalsCalculatePrices": 0,
    "decimalsCalculateCosts": 0
  },
  "manufacturer": true,
  "importer": true,
  "active": true,
  "notCreateOrder": true,
  "observation": "string",
  "geographicalLocation": "NATIONAL",
  "creationDate": "2019-08-24",
  "inactiveDate": "2019-08-24",
  "accountingAccount": {
    "id": 1,
    "code": 1000,
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": 100,
    "parentDescription": "Assets"
  },
  "customer": {
    "id": 10001,
    "code": 10001,
    "name": "Acme S.A.",
    "commercialName": "Acme España",
    "cif": "B12345678",
    "address": "Av. de la Estación, 5",
    "firstPhoneNumber": "+34600111222",
    "secondPhoneNumber": "+34600333444",
    "postalCode": "03001",
    "countryDescription": "Spain",
    "stateDescription": "Alicante",
    "email": "info@acme.es",
    "city": "Alicante",
    "activity": "Wholesale Trade",
    "brand": "Acme",
    "brandId": 100,
    "creationDate": "2020-01-01",
    "isActive": true,
    "inactiveDate": "2023-08-07",
    "paymentMethodId": 1,
    "paymentMethod": "Bank Transfer",
    "paymentMethodServeFullPrePaid": false,
    "rateCode": "RATE-001",
    "account": "ES9820385778983000760236",
    "vatDescription": "General",
    "discount1": 5,
    "currencyCode": "EUR",
    "currencyDescription": "Euro",
    "modifiedOn": "2024-08-07T12:30:00",
    "bankName": "Santander",
    "contactPerson": "Juan Pérez",
    "web": "https://www.acme.es",
    "picture": "https://www.acme.es/logo.png",
    "pictureToken": "xyz-token-241235",
    "tags": [ … ]
  },
  "operator": {
    "id": 1,
    "code": 0,
    "name": "string"
  },
  "warehouse": {
    "id": 1,
    "code": "ALM01",
    "description": "Central warehouse"
  },
  "email": "string",
  "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"
  },
  "terms": 0,
  "daysFirstTerm": 0,
  "daysBetweenTerms": 0,
  "discount1": 0,
  "discount2": 0,
  "discountPp": 0,
  "proximityType": "NEARBY",
  "paymentDay1": 0,
  "paymentDay2": 0,
  "paymentDay3": 0,
  "weekday": "MONDAY",
  "paymentMethodObservation": {
    "id": 1,
    "code": "string",
    "type": "CLASSIFICATION",
    "description": "string",
    "blockOrder": true
  },
  "paymentMethodObservationDescription": "string",
  "account": "string",
  "swift": "string",
  "bic": "string",
  "agency": {
    "id": 1,
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "shippingTerm": {
    "id": 1,
    "code": "string",
    "customerPays": true,
    "intrastatCode": "string"
  },
  "ropoCode": "string",
  "ropoExpireDate": "2019-08-24",
  "tags": [
    "string"
  ],
  "irpfType": "LEASES",
  "bankName": "string",
  "contactPerson": "string",
  "picture": "string",
  "pictureToken": "string",
  "incomeTaxRate": 0,
  "web": "string",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "observations": [
    { … }
  ],
  "files": [
    { … }
  ]
}

List Suppliers

Request

Get all your suppliers.

Bodyapplication/jsonrequired
conditionobject(ApiCondition)
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/supplier/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(ApiSupplierListReadDto)required

List of data items for the current page

data[].​idinteger(int32)required

Unique identifier of the entity

Example: 1
data[].​codeinteger(int32)required
data[].​cifstringrequired
data[].​commercialNamestringrequired
data[].​namestring
data[].​addressstring
data[].​countrystring
data[].​statestring
data[].​postalCodestring
data[].​citystring
data[].​phone1string
data[].​phone2string
data[].​currencystring
data[].​currencyNomenclaturestring
data[].​currencyChangeValuenumber
data[].​activeboolean
data[].​emailstring
data[].​shippingTerminteger(int32)
data[].​tagsArray of strings
data[].​vatDescriptionstring
data[].​discount1number
data[].​paymentMethodIdinteger(int32)
data[].​paymentMethodstring
data[].​currencyCodestring
data[].​creationDatestring(date)
data[].​inactiveDatestring(date)
data[].​countryDescriptionstring
data[].​stateDescriptionstring
data[].​bankNamestring
data[].​accountstring
data[].​picturestring
data[].​pictureTokenstring
data[].​modifiedOnstring(date-time)
data[].​webstring
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
}

Sale Price

Manage your Sale Prices

Operations

Purchase Invoice

Manage your Purchase Invoices

Operations

State

Manage your states

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