Skip to content

updateOrder_1

Request

Path
idinteger, (int32)required
Bodyapplication/jsonrequired
numberinteger
documentDatestring, (date)
quantityTotalnumber
observationsstring
linesArray of objects(ApiOrderLineWriteDto)
idinteger, (int32)

Order identifier for updates.

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

Billing series identifier.

Default:""
Example:1
serviceDatestring, (date)

Service date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
manufacturingDatestring, (date)

Manufacturing date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
seasoninteger, (int32)

Season identifier.

Default:""
Example:1
warehouseinteger, (int32)

Warehouse identifier.

Default:""
Example:1
customerAddressinteger, (int32)required

Customer address identifier.

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

Order type identifier.

Default:""
Example:1
quoteinteger, (int32)

Related quote identifier.

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

Rate code identifier.

Default:""
Example:1
referencestring, [ 0 .. 50 ] characters

Reference number.

Default:""
Example:"REF-001"
billingObservationsstring

Billing observations.

Default:""
Example:"Special billing instructions"
paymentMethodinteger, (int32)

Payment method identifier.

Default:""
Example:1
firstTerminteger, (int32)

First term days.

Default:""
Example:30
daysTerminteger, (int32)

Days term.

Default:""
Example:30
termsinteger, (int32)

Number of terms.

Default:""
Example:3
proximityTypestring(ApiProximityTypeEnum)

Proximity type for date calculation.

Default:""
Enum:"NEARBY""PREVIOUS""LATER"
irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""
Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"
Example:"AGRO"
discount1number

First discount percentage.

Default:""
Example:5
discount2number

Second discount percentage.

Default:""
Example:3
discount3number

Third discount percentage.

Default:""
Example:2.5
discount4number

Fourth discount percentage.

Default:""
Example:1
discountPpnumber

Additional discount percentage.

Default:""
Example:0.5
currencyinteger, (int32)

Currency identifier.

Default:""
Example:1
changenumber

Change/payment difference.

Default:""
Example:10.5
ibanstring, [ 0 .. 50 ] characters

IBAN account number.

Default:""
Example:"ES7501234567890123456789"
customerVatTypeinteger, (int32)

Customer VAT type identifier.

Default:""
Example:1
billingCompanyinteger, (int32)

Billing company identifier.

Default:""
Example:1
collectedAmountnumber

Collected amount.

Default:""
Example:500
withholdingnumber

Withholding tax percentage.

Default:""
Example:1
representative1integer, (int32)

First representative identifier.

Default:""
Example:1
commissionType1string, [ 0 .. 20 ] characters

First commission type (PERCENTAGE, FIXED, etc.)

Default:""
commission1number

First commission percentage.

Default:""
Example:5
representative2integer, (int32)

Second representative identifier.

Default:""
Example:2
commissionType2string, [ 0 .. 20 ] characters

Second commission type (PERCENTAGE, FIXED, etc.)

Default:""
commission2number

Second commission percentage.

Default:""
Example:3
representative3integer, (int32)

Third representative identifier.

Default:""
Example:3
commissionType3string, [ 0 .. 20 ] characters

Third commission type (PERCENTAGE, FIXED, etc.)

Default:""
commission3number

Third commission percentage.

Default:""
Example:2
valueDatestring, (date)

Value date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
agencyinteger, (int32)

Agency identifier.

Default:""
Example:1
shippingTerminteger, (int32)

Shipping term identifier.

Default:""
Example:1
shippingAmountnumber

Shipping amount.

Default:""
Example:50
shippingVatTypestring

Shipping VAT type.

Default:""
Example:"STANDARD"
shippingVatPercentagenumber

Shipping VAT percentage.

Default:""
Example:21
shippingSurchargePercentagenumber

Shipping surcharge percentage.

Default:""
Example:5
packagesinteger, (int32)

Number of packages.

Default:""
Example:5
grossWeightnumber

Gross weight.

Default:""
Example:150.5
netWeightnumber

Net weight.

Default:""
Example:100.5
volumenumber

Volume.

Default:""
Example:5
noAccumulateWarehouseboolean

Flag to not accumulate warehouse.

Default:false
Example:false
collectedAmountCompanyCurrencynumber

Collected amount in company currency.

Default:""
Example:500
grossAmountTotalnumber

Gross amount total.

Default:""
Example:1000
grossAmountTotalCompanyCurrencynumber

Gross amount total in company currency.

Default:""
Example:1000
discountAmountTotalnumber

Discount amount total.

Default:""
Example:100
discountAmountTotalCompanyCurrencynumber

Discount amount total in company currency.

Default:""
Example:100
netAmountTotalnumber

Net amount total.

Default:""
Example:900
netAmountTotalCompanyCurrencynumber

Net amount total in company currency.

Default:""
Example:900
vatAmountTotalnumber

VAT amount total.

Default:""
Example:189
vatAmountTotalCompanyCurrencynumber

VAT amount total in company currency.

Default:""
Example:189
totalnumber

Total amount.

Default:""
Example:1089
totalCompanyCurrencynumber

Total in company currency.

Default:""
Example:1089
noAccumulateRiskboolean

Flag to not accumulate risk.

Default:false
Example:false
invoiceEditObservationsstring

Invoice edit observations.

Default:""
Example:"Special notes for invoicing"
tagsArray of strings

List of order tags.

Default:""
cmsOrderIdinteger, (int64)

CMS order identifier.

Default:""
Example:12345
shopinteger, (int32)

Shop identifier.

Default:""
Example:1
usersCompany1integer, (int32)

First company user identifier.

Default:""
Example:1
usersCompany2integer, (int32)

Second company user identifier.

Default:""
Example:2
usersCompany3integer, (int32)

Third company user identifier.

Default:""
Example:3
documentTemplateinteger, (int32)

Document template identifier selected for PDF generation.

Default:""
Example:100
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
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
PUT
/api/v1/order/{id}
curl -i -X PUT \
  'https://api.prana.software/api/v1/order/{id}' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
numberintegerrequired
documentDatestring, (date)required
quantityTotalnumber
observationsstring
linesArray of objects(ApiOrderLineReadDto)
changenumber
discount1number
discount2number
discountAmountTotalnumber
discountAmountTotalCompanyCurrencynumber
discountPpnumber
discountPpAmountTotalnumber
discountPpAmountTotalCompanyCurrencynumber
grossAmountTotalnumber
grossAmountTotalCompanyCurrencynumber
netAmountTotalnumber
netAmountTotalCompanyCurrencynumber
vatAmountTotalnumber
vatAmountTotalCompanyCurrencynumber
surchargeAmountTotalnumber
surchargeAmountTotalCompanyCurrencynumber
withholdingnumber
withholdingAmountTotalnumber
withholdingAmountTotalCompanyCurrencynumber
totalnumber
totalCompanyCurrencynumber
disbursementAmountTotalnumber
disbursementAmountTotalCompanyCurrencynumber
billingSeriesobject(ApiBillingSeriesListReadDto)

Billing series details.

Default:""
serviceDatestring, (date)

Service date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
manufacturingDatestring, (date)

Manufacturing date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
seasonobject(ApiSeasonListReadDto)

Season details.

Default:""
warehouseobject(ApiWarehouseListReadDto)

Warehouse details.

Default:""
customerAddressobject(ApiCustomerAddressViewReadDto)required

Customer address details.

Default:""
orderTypeobject(ApiOrderTypeListReadDto)

Order type details.

Default:""
rateCodeobject(ApiRateCodeListReadDto)

Rate code details.

Default:""
referencestring

Reference number.

Default:""
Example:"REF-001"
billingObservationsstring

Billing observations.

Default:""
Example:"Special billing instructions"
paymentMethodobject(ApiPaymentMethodListReadDto)

Payment method details.

Default:""
firstTerminteger, (int32)

First term days.

Default:""
Example:30
daysTerminteger, (int32)

Days term.

Default:""
Example:30
termsinteger, (int32)

Number of terms.

Default:""
Example:3
proximityTypestring(ApiProximityTypeEnum)

Proximity type for date calculation.

Default:""
Enum:"NEARBY""PREVIOUS""LATER"
irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""
Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"
Example:"AGRO"
discount3number

Third discount percentage.

Default:""
Example:5
discount4number

Fourth discount percentage.

Default:""
Example:2.5
currencyobject(ApiCurrencyListReadDto)

Currency details.

Default:""
ibanstring

IBAN account number.

Default:""
Example:"ES7501234567890123456789"
customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type details.

Default:""
billingCompanyobject(ApiCompanyInfoListReadDto)

Billing company details.

Default:""
collectedAmountnumber

Collected amount.

Default:""
Example:500
collectedAmountCompanyCurrencynumber

Collected amount in company currency.

Default:""
Example:500
representative1object(ApiRepresentativeListReadDto)

First representative details.

Default:""
commissionType1string(ApiCommissionTypeEnum)

First commission type (PERCENTAGE, FIXED, etc.)

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission1number

First commission amount.

Default:""
Example:100
representative2object(ApiRepresentativeListReadDto)

Second representative details.

Default:""
commissionType2string(ApiCommissionTypeEnum)

Second commission type (PERCENTAGE, FIXED, etc.)

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission2number

Second commission amount.

Default:""
Example:75
representative3object(ApiRepresentativeListReadDto)

Third representative details.

Default:""
commissionType3string(ApiCommissionTypeEnum)

Third commission type (PERCENTAGE, FIXED, etc.)

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission3number

Third commission amount.

Default:""
Example:50
valueDatestring, (date)

Value date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
agencyobject(ApiAgencyListReadDto)

Agency details.

Default:""
shippingTermobject(ApiShippingTermListReadDto)

Shipping term details.

Default:""
shippingVatTypestring

Shipping VAT type.

Default:""
Example:"STANDARD"
shippingVatPercentagenumber

Shipping VAT percentage.

Default:""
Example:21
shippingSurchargePercentagenumber

Shipping surcharge percentage.

Default:""
Example:5
shippingAmountnumber

Shipping amount.

Default:""
Example:50
packagesinteger, (int32)

Number of packages.

Default:""
Example:5
grossWeightnumber

Gross weight.

Default:""
Example:150.5
netWeightnumber

Net weight.

Default:""
Example:100.5
volumenumber

Volume.

Default:""
Example:5
noAccumulateWarehouseboolean

Flag to not accumulate warehouse.

Default:false
Example:false
cancelledQuantityTotalnumber

Cancelled quantity total.

Default:""
Example:0
servedQuantityTotalnumber

Served quantity total.

Default:""
Example:100
pendingQuantityTotalnumber

Pending quantity total.

Default:""
Example:0
effectiveQuantityTotalnumber

Effective quantity total.

Default:""
Example:0
noAccumulateRiskboolean

Flag to not accumulate risk.

Default:false
Example:false
lockedboolean

Flag indicating order is locked.

Default:false
Example:false
netAmountPendingTotalnumber

Net amount pending total.

Default:""
Example:500
invoiceEditObservationsstring

Invoice edit observations.

Default:""
Example:"Special notes for invoicing"
invoicesArray of objects(ApiLastInfoResponseDto)

List of related invoices.

Default:""
tagsArray of strings

List of order tags.

Default:""
receiptCollectionsArray of objects(ApiQuoteReceiptCollectionListReadDto)

List of receipt collections.

Default:""
discount1AmountTotalnumber

First discount amount total.

Default:""
Example:100
discount1AmountTotalCompanyCurrencynumber

First discount amount total in company currency.

Default:""
Example:100
discount2AmountTotalnumber

Second discount amount total.

Default:""
Example:50
discount2AmountTotalCompanyCurrencynumber

Second discount amount total in company currency.

Default:""
Example:50
discount3AmountTotalnumber

Third discount amount total.

Default:""
Example:25
discount3AmountTotalCompanyCurrencynumber

Third discount amount total in company currency.

Default:""
Example:25
discount4AmountTotalnumber

Fourth discount amount total.

Default:""
Example:10
discount4AmountTotalCompanyCurrencynumber

Fourth discount amount total in company currency.

Default:""
Example:10
quoteNumberinteger

Related quote number.

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

Related quote identifier.

Default:""
Example:100
reportTokenstring

Report token for downloading.

Default:""
Example:"token-xyz"
reportUrlstring

Report URL.

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

Report name.

Default:""
Example:"OrderReport"
emailSentboolean

Flag indicating email was sent.

Default:false
Example:true
cmsOrderIdinteger, (int64)

CMS order identifier.

Default:""
Example:12345
shopobject(ApiShopListReadDto)

Shop details.

Default:""
usersCompany1object(ApiUsersCompanyListReadDto)

First company user details.

Default:""
usersCompany2object(ApiUsersCompanyListReadDto)

Second company user details.

Default:""
usersCompany3object(ApiUsersCompanyListReadDto)

Third company user details.

Default:""
documentTemplateobject(ApiDocumentTemplateListReadDto)

Document template selected for PDF generation.

Default:""
projectobject(ApiProjectListReadDto)

Associated project.

Default:""
Response
// No response example