createPurchaseInvoice

Request

Bodyapplication/jsonrequired

idinteger, (int32)

Identifier of the object to modify or delete

Default:""

valueDatestring, (date)

Value date (yyyy-MM-dd)

Default:""

Example:"2024-08-01"

lockedboolean

Locked flag

Default:false

Example:false

accountedboolean

Accounted flag

Default:false

Example:true

countedboolean

Counted flag

Default:false

Example:true

packagesinteger, (int32)

Number of packages

Default:""

Example:3

observationsstring

Observations

Default:""

Example:"Special instructions"

billingObservationsstring

Billing observations

Default:""

Example:"Include VAT"

paymentMethodinteger, (int32)

Payment method identifier

Default:""

Example:1

firstTerminteger, (int32)

First term days

Default:""

Example:0

daysTerminteger, (int32)

Days term

Default:""

Example:30

termsinteger, (int32)

Number of terms

Default:""

Example:1

proximityTypestring(ApiProximityTypeEnum)

Proximity type

Default:""

Enum:"NEARBY""PREVIOUS""LATER"

Example:"END_OF_MONTH"

tagsArray of strings

Associated tags

Default:""

Example:

[
  "urgent"
]

accountingAccountinteger, (int32)

Accounting account identifier

Default:""

Example:7000001

statusstring(ApiStatusInvoiceEnum)

Invoice status

Default:""

Enum:"PENDING""PAID""PARTIALLY_PAID""DRAFT"

Example:"ISSUED"

irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""

Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"

Example:"AGRO"

referencestring

Reference number

Default:""

Example:"REF-2024-001"

customerVatTypeinteger, (int32)

Customer VAT type identifier

Default:""

Example:1

billingSeriesinteger, (int32)

Billing series identifier

Default:""

Example:1

shippingTerminteger, (int32)

Shipping term identifier

Default:""

Example:1

currencyinteger, (int32)

Currency identifier

Default:""

Example:1

changenumber

Currency exchange rate

Default:""

Example:1.05

discount1number

Discount 1 percentage

Default:""

Example:10

discount2number

Discount 2 percentage

Default:""

Example:5

discount3number

Discount 3 percentage

Default:""

Example:2.5

discount4number

Discount 4 percentage

Default:""

Example:1

discountPpnumber

Discount PP percentage

Default:""

Example:0.5

withholdingnumber

Withholding percentage

Default:""

Example:1.5

numberinteger

Invoice number

Default:""

Example:1001

documentDatestring, (date)

Document date (yyyy-MM-dd)

Default:""

Example:"2024-08-01"

expirationDatestring, (date)

Expiration date (yyyy-MM-dd)

Default:""

Example:"2024-09-01"

warehouseinteger, (int32)

Warehouse identifier

Default:""

Example:1

manualboolean

Manual invoice flag

Default:false

Example:false

vatOperationTypeinteger, (int32)

VAT operation type identifier

Default:""

Example:1

typestring(ApiInvoiceTypeEnum)

Invoice type

Default:""

Enum:"INVOICE""TICKET""CORRECTIVE_INVOICE"

Example:"INVOICE"

importedboolean

Imported invoice flag

Default:false

Example:false

periodIdinteger, (int32)

Accounting period identifier. When provided, overrides the period derived from the authentication token. Intended for API key callers that manage period resolution explicitly.

Default:""

Example:3

receiptsArray of objects(ApiPurchaseReceiptWriteDto)

taxesArray of objects(ApiPurchaseTaxesWriteDto)

deliveryNotesArray of objects(ApiPurchaseInvoiceDeliveryNoteWriteDto)

purchasingAccountinteger, (int32)

supplierinteger, (int32)required

receivedDatestring, (date)

billCodestring

deliveryNotestring

correctiveInvoiceinteger, (int32)

model347boolean

operationDescriptionstring, [ 0 .. 250 ] characters

siiOperationKey340string(ApiOperationKey340Enum)

Default:null

Enum:"USUAL_OPERATION""A""B""C""D""E""F""G""H""I"

siiSubtypestring(ApiSiiSubTypeEnum)

Default:null

Enum:"EMPTY""R1""R2""R3""R4""R5"

siiRecordDatestring, (date)

projectIdinteger, (int32)

Default project for new lines. The actual project link is line-level — this field only pre-fills new lines and is not used for project document searches.

Default:""

Example:1

skipAuditboolean

skipReportGenerationboolean

POST

/api/v1/purchase-invoice

curl -i -X POST \
  https://api.prana.software/api/v1/purchase-invoice \
  -H 'Content-Type: application/json'

Responses

Bodyapplication/json

idinteger, (int32)required

Unique identifier of the object

Default:""

observationsstring

Observations or notes

Default:""

Example:"Special instructions for handling"

numberinteger

Invoice number

Default:""

Example:1001

documentDatestring, (date)

Document date (yyyy-MM-dd)

Default:""

Example:"2024-08-01"

quantityTotalnumber

Total quantity

Default:""

Example:100

billingSeriesobject(ApiBillingSeriesListReadDto)

Billing series information

Default:""

lockedboolean

Locked flag

Default:false

Example:false

accountedboolean

Accounted flag

Default:false

Example:true

grossAmountTotalnumber

Total gross amount

Default:""

Example:1500

grossAmountTotalCompanyCurrencynumber

Total gross amount in company currency

Default:""

Example:1500

discount1AmountTotalnumber

Discount 1 total amount

Default:""

Example:100

discount1AmountTotalCompanyCurrencynumber

Discount 1 total amount in company currency

Default:""

Example:100

discount2AmountTotalnumber

Discount 2 total amount

Default:""

Example:50

discount2AmountTotalCompanyCurrencynumber

Discount 2 total amount in company currency

Default:""

Example:50

discountPpnumber

Discount PP percentage

Default:""

Example:5

discountPpAmountTotalCompanyCurrencynumber

Discount PP total amount in company currency

Default:""

Example:25

netAmountTotalnumber

Total net amount

Default:""

Example:1325

netAmountTotalCompanyCurrencynumber

Total net amount in company currency

Default:""

Example:1325

vatAmountTotalnumber

Total VAT amount

Default:""

Example:278.25

vatAmountTotalCompanyCurrencynumber

Total VAT amount in company currency

Default:""

Example:278.25

surchargeAmountTotalnumber

Total surcharge amount

Default:""

Example:30

surchargeAmountTotalCompanyCurrencynumber

Total surcharge amount in company currency

Default:""

Example:30

totalnumber

Total amount

Default:""

Example:1633.25

totalCompanyCurrencynumber

Total in company currency

Default:""

Example:1633.25

paymentMethodobject(ApiPaymentMethodListReadDto)

Payment method information

Default:""

firstTerminteger, (int32)

First term days

Default:""

Example:0

daysTerminteger, (int32)

Days term

Default:""

Example:30

termsinteger, (int32)

Number of terms

Default:""

Example:1

proximityTypestring(ApiProximityTypeEnum)

Proximity type

Default:""

Enum:"NEARBY""PREVIOUS""LATER"

Example:"END_OF_MONTH"

discount1number

Discount 1 percentage

Default:""

Example:10

discount2number

Discount 2 percentage

Default:""

Example:5

currencyobject(ApiCurrencyListReadDto)

Currency information

Default:""

changenumber

Currency exchange rate

Default:""

Example:1.05

ibanstring

IBAN account number

Default:""

Example:"ES7501234567890123456789"

withholdingnumber

Withholding percentage

Default:""

Example:1.5

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type information

Default:""

billingObservationsstring

Billing observations

Default:""

Example:"Include VAT in final bill"

paidCommissionsboolean

Paid commissions flag

Default:false

Example:false

packagesinteger, (int32)

Number of packages

Default:""

Example:3

tagsArray of strings

Associated tags

Default:""

Example:

[
  "urgent",
  "priority"
]

statusstring(ApiStatusInvoiceEnum)

Invoice status

Default:""

Enum:"PENDING""PAID""PARTIALLY_PAID""DRAFT"

Example:"ISSUED"

irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""

Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"

Example:"AGRO"

referencestring

Reference number

Default:""

Example:"REF-2024-001"

valueDatestring, (date)

Value date (yyyy-MM-dd)

Default:""

Example:"2024-08-01"

shippingTermobject(ApiShippingTermListReadDto)

Shipping term information

Default:""

irpfAmountTotalnumber

Total IRPF/withholding amount

Default:""

Example:20

withholdingAmountTotalnumber

Total withholding amount

Default:""

Example:25

withholdingAmountTotalCompanyCurrencynumber

Total withholding amount in company currency

Default:""

Example:25

disbursementAmountTotalnumber

Total disbursement amount

Default:""

Example:50

disbursementAmountTotalCompanyCurrencynumber

Total disbursement amount in company currency

Default:""

Example:50

collectedAmountnumber

Collected amount

Default:""

Example:800

collectedAmountCompanyCurrencynumber

Collected amount in company currency

Default:""

Example:800

expirationDatestring, (date)

Expiration date (yyyy-MM-dd)

Default:""

Example:"2024-09-01"

warehouseListReadDtoobject(ApiWarehouseListReadDto)

Warehouse information

Default:""

vatOperationTypeobject(ApiVatOperationTypeListReadDto)

VAT operation type information

Default:""

manualboolean

Manual invoice flag

Default:false

Example:false

typestring(ApiInvoiceTypeEnum)

Invoice type

Default:""

Enum:"INVOICE""TICKET""CORRECTIVE_INVOICE"

Example:"INVOICE"

amountReconciliationnumber

Reconciliation amount

Default:""

Example:0

amountReconciliationCompanyCurrencynumber

Reconciliation amount in company currency

Default:""

Example:0

importedboolean

Imported invoice flag

Default:false

Example:false

taxesArray of objects(ApiPurchaseTaxesListReadDto)

List of purchase invoice taxes

Default:""

receiptsArray of objects(ApiPurchaseInvoicePurchaseReceiptListReadDto)

List of purchase receipts

Default:""

deliveryNotesArray of objects(ApiPurchaseDeliveryNoteReadDto)

List of purchase delivery notes

Default:""

filesArray of objects(ApiPurchaseInvoiceFileListReadDto)

List of purchase invoice files

Default:""

supplierobject(ApiSupplierListReadDto)

Supplier information

Default:""

purchasingAccountobject(ApiChartAccountListReadDto)

Purchasing account information

Default:""

correctiveInvoiceobject(ApiPurchaseInvoiceListReadDto)

Corrective purchase invoice information

Default:""

billCodestring

Bill code

Default:""

Example:"BILL-2024-001"

receivedDatestring, (date)

Received date (yyyy-MM-dd)

Default:""

Example:"2024-08-10"

model347boolean

Model 347 flag

Default:false

Example:false

operationDescriptionstring

Operation description

Default:""

Example:"Regular purchase"

siiOperationKey340string(ApiOperationKey340Enum)

SII operation key 340

Default:""

Enum:"USUAL_OPERATION""A""B""C""D""E""F""G""H""I"

Example:"E"

siiSubtypestring(ApiSiiSubTypeEnum)

SII subtype

Default:""

Enum:"EMPTY""R1""R2""R3""R4""R5"

Example:"RECTIFIED"

siiRecordDatestring, (date)

SII record date (yyyy-MM-dd)

Default:""

Example:"2024-08-15"

projectobject(ApiProjectListReadDto)

Associated project.

Default:""

Response

// No response example