Skip to content

patchInvoice

Request

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

Responses

OK

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(ApiTaxesListReadDto)

List of invoice taxes

Default:""
receiptsArray of objects(ApiInvoiceReceiptReadDto)

List of invoice receipts

Default:""
deliveryNotesArray of objects(ApiDeliveryNoteReadDto)

List of delivery notes

Default:""
invoicePosPaymentTypesArray of objects(ApiInvoicePosPaymentTypeListReadDto)

List of invoice POS payment types

Default:""
customerAddressobject(ApiCustomerAddressViewReadDto)

Customer address information

Default:""
rateCodeobject(ApiRateCodeListReadDto)

Rate code information

Default:""
discount3number

Discount 3 percentage

Default:""
Example:2.5
discount4number

Discount 4 percentage

Default:""
Example:1
discount3AmountTotalnumber

Discount 3 total amount

Default:""
Example:50
discount3AmountTotalCompanyCurrencynumber

Discount 3 total amount in company currency

Default:""
Example:50
discount4AmountTotalnumber

Discount 4 total amount

Default:""
Example:25
discount4AmountTotalCompanyCurrencynumber

Discount 4 total amount in company currency

Default:""
Example:25
discountPpAmountTotalnumber

Discount PP total amount

Default:""
Example:10
percentageIrpfnumber

IRPF percentage

Default:""
Example:1.5
shippingAmountnumber

Shipping amount

Default:""
Example:50
shippingAmountCompanyCurrencynumber

Shipping amount in company currency

Default:""
Example:50
manualExpirationboolean

Manual expiration flag

Default:false
Example:false
commissionsArray of objects(ApiCommissionInvoiceListReadDto)

List of commissions

Default:""
sellerCommissionsArray of objects(ApiSellerCommissionInvoiceListReadDto)

List of seller commissions

Default:""
ediInvoiceTypestring(ApiEdiInvoiceTypeEnum)

EDI invoice type

Default:""
Enum:"COMMERCIAL_INVOICE""CREDIT_NOTE""CHARGE_NOTE""SUMMARY_INVOICE""PROFORMA_INVOICE""AUTO_INVOICE"
Example:"INVOICE"
electronicInvoiceSentstring

Electronic invoice sent status

Default:""
Example:"PENDING"
deliveryTermsstring

Delivery terms

Default:""
Example:"CIF"
intrastatNatureTransactionstring

Intrastat nature of transaction

Default:""
Example:"SUPPLY"
intrastatShippingTermstring

Intrastat shipping term

Default:""
Example:"CIF"
intrastatPortstring

Intrastat port

Default:""
Example:"MADRID"
returnReasonstring

Return reason

Default:""
Example:"DEFECTIVE"
correctiveInvoiceobject(ApiInvoiceListReadDto)

Corrective invoice information

Default:""
manualReceiptsboolean

Manual receipts flag

Default:false
Example:false
quoteNumberinteger

Related quote number

Default:""
Example:2024001
quoteIdinteger, (int32)

Related quote identifier

Default:""
Example:100
templateSaleInvoiceNumberinteger

Template sale invoice number

Default:""
Example:2024001
templateSaleInvoiceIdinteger, (int32)

Template sale invoice identifier

Default:""
Example:100
dateRecurringSaleInvoiceIdinteger, (int32)

Recurring sale invoice identifier

Default:""
Example:100
dateRecurringSaleInvoiceDatestring, (date)

Recurring sale invoice date (yyyy-MM-dd)

Default:""
Example:"2024-08-01"
salesAccountobject(ApiChartAccountListReadDto)

Sales account information

Default:""
invoiceEditObservationsstring

Invoice edit observations

Default:""
Example:"Modified on 2024-08-10"
grossWeightnumber

Gross weight

Default:""
Example:250.5
netWeightnumber

Net weight

Default:""
Example:200
volumenumber

Volume

Default:""
Example:5.25
transportTypestring

Transport type

Default:""
Example:"TRUCK"
agentDutystring

Agent duty

Default:""
Example:"SENDER"
creditLetterstring

Credit letter number

Default:""
Example:"CL-2024-001"
administrativeCenterAccountingOfficestring

Administrative center accounting office

Default:""
Example:"MADRID"
administrativeCenterManagingBodystring

Administrative center managing body

Default:""
Example:"TAX_OFFICE"
administrativeCenterProcessingUnitstring

Administrative center processing unit

Default:""
Example:"UNIT_001"
administrativeCenterProposingBodystring

Administrative center proposing body

Default:""
Example:"TREASURY"
correctiveReasonstring(ApiCorrectiveReasonEnum)

Corrective reason

Default:""
Enum:"INVOICE_NUMBER""INVOICE_SERIES""EXPEDITION_DATE""ISSUER_NAME""RECEIVER_NAME""ISSUER_TAX_ID""RECIPIENT_TAX_ID""ISSUING_ADDRESS""RECEIVING_ADDRESS""OPERATION_DETAIL"
Example:"ERROR"
invoiceTypeCodestring(ApiInvoiceTypeCodeEnum)

Invoice type code

Default:""
Enum:"F1""F2""F3""R1""R2""R3""R4""R5"
Example:"NORMAL"
operationDescriptionstring

Operation description

Default:""
Example:"Regular supply"
vatCodestring(ApiVatCodeEnum)

VAT code

Default:""
Enum:"C01""C02""C03""C04""C05""C06""C07""C08""C09""C10"
Example:"S"
vatCodeVerifactustring(ApiVatCodeVerifactuEnum)

VAT code for Verifactu

Default:""
Enum:"C01""C02""C03""C04""C05""C06""C07""C08""C09""C10"
Example:"01"
epigraphstring

Epigraph code

Default:""
Example:"6211"
operationTypestring(ApiOperationTypeEnum)

Operation type

Default:""
Enum:"SERVICES_PROVISION""GOODS_DELIVERY"
Example:"NORMAL"
operationClassificationstring(ApiOperationClassificationEnum)

Operation classification

Default:""
Enum:"S1""S2"
Example:"INTRA_EU"
exemptCausestring(ApiExemptCauseEnum)

Exempt cause

Default:""
Enum:"E1""E2""E3""E4""E5""E6""N1""N2"
Example:"EXPORT"
ticketbaiLogobject(ApiTicketbaiLogReadDto)

TicketBAI log information

Default:""
model347boolean

Model 347 flag

Default:false
Example:false
reportTokenstring

Report token

Default:""
Example:"TOKEN-2024-001"
reportUrlstring

Report URL

Default:""
Example:"https://example.com/report"
reportNamestring

Report name

Default:""
Example:"Invoice_2024_001"
billingSeriesOriginobject(ApiBillingSeriesListReadDto)

Billing series origin information

Default:""
verifactuLogobject(ApiVerifactuLogReadDto)

Verifactu log information

Default:""
draftboolean

Draft flag

Default:false
Example:false
externalCodestring

External code

Default:""
Example:"EXT-001"
trialboolean

Trial flag

Default:false
Example:false
confirmationDatestring, (date)

Confirmation date (yyyy-MM-dd)

Default:""
Example:"2024-08-02"
otherSIFboolean

Other SIF flag

Default:false
Example:false
emailSentboolean

Email sent flag

Default:false
Example:true
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"
usersCompany1object(ApiUsersCompanyListReadDto)

Associated company user 1

Default:""
usersCompany2object(ApiUsersCompanyListReadDto)

Associated company user 2

Default:""
usersCompany3object(ApiUsersCompanyListReadDto)

Associated company user 3

Default:""
documentTemplateobject(ApiDocumentTemplateListReadDto)

Document template selected for PDF generation

Default:""
projectobject(ApiProjectListReadDto)

Associated project.

Default:""
Response
// No response example