patchPurchaseOrder

Request

Path

idinteger, (int32)required

Bodyapplication/jsonrequired

property name*anyadditional property

PATCH

/api/v1/purchase-order/{id}

curl -i -X PATCH \
  'https://api.prana.software/api/v1/purchase-order/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "property1": null,
    "property2": null
  }'

Responses

Bodyapplication/json

idinteger, (int32)required

Unique identifier of the object

Default:""

numberintegerrequired

documentDatestring, (date)required

quantityTotalnumber

observationsstring

linesArray of objects(ApiPurchaseOrderLineReadDto)

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 information.

Default:""

approximateDeliveryDatestring, (date)

Approximate delivery date. Format: yyyy-MM-dd

Default:""

Example:"2025-01-15"

actualDeliveryDatestring, (date)

Actual delivery date. Format: yyyy-MM-dd

Default:""

Example:"2025-01-20"

warehouseobject(ApiWarehouseListReadDto)

Warehouse information.

Default:""

noAccumulateWarehouseboolean

Flag indicating no warehouse accumulation.

Default:false

Example:false

cancelledQuantityTotalnumber

Cancelled quantity total.

Default:""

Example:0

effectiveQuantityTotalnumber

Effective quantity total.

Default:""

Example:0

supplierobject(ApiSupplierListReadDto)

Supplier information.

Default:""

supplierNamestring

Supplier name.

Default:""

Example:"Supplier Company SL"

supplierAddressstring

Supplier address.

Default:""

Example:"123 Main St, Madrid"

supplierPhonestring

Supplier phone number.

Default:""

Example:"+34 91 123 4567"

supplierEmailstring

Supplier email address.

Default:""

Example:"contact@supplier.com"

supplierCifstring

Supplier CIF/Tax ID.

Default:""

Example:"A12345678"

referencestring

Reference or purchase order identifier.

Default:""

Example:"PO-2024-001"

shippingVatPercentagenumber

Shipping VAT percentage.

Default:""

Example:21

shippingTermobject(ApiShippingTermListReadDto)

Shipping term information.

Default:""

shippingVatTypestring

Shipping VAT type/code.

Default:""

Example:"S"

shippingAmountnumber

Shipping amount.

Default:""

Example:50

shippingSurchargePercentagenumber

Shipping surcharge percentage.

Default:""

Example:5

cancelledQuantitynumber

Cancelled quantity.

Default:""

Example:5

servedQuantityTotalnumber

Total served quantity.

Default:""

Example:75.5

pendingAmountTotalnumber

Total pending amount.

Default:""

Example:150

pendingAmountTotalCompanyCurrencynumber

Total pending amount in company currency.

Default:""

Example:150

taxesAndAmountnumber

Taxes and amount combined total.

Default:""

Example:1350.36

billingObservationsstring

Billing observations or notes.

Default:""

Example:"Special handling required"

currencyobject(ApiCurrencyListReadDto)

Currency information.

Default:""

customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type information.

Default:""

paymentMethodobject(ApiPaymentMethodListReadDto)

Payment method information.

Default:""

firstTerminteger, (int32)

First payment term in days.

Default:""

Example:30

daysTerminteger, (int32)

Days for each payment term.

Default:""

Example:15

termsinteger, (int32)

Total number of payment terms.

Default:""

Example:3

proximityTypestring(ApiProximityTypeEnum)

Proximity type for delivery.

Default:""

Enum:"NEARBY""PREVIOUS""LATER"

irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""

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

Example:"AGRO"

netAmountPendingTotalnumber

Net amount pending total.

Default:""

Example:500

invoiceEditObservationsstring

Invoice edit observations or notes.

Default:""

Example:"Adjust quantities as needed"

tagsArray of strings

List of tags associated with the purchase order.

Default:""

discount1AmountTotalnumber

Discount 1 amount total.

Default:""

Example:100

discount1AmountTotalCompanyCurrencynumber

Discount 1 amount total in company currency.

Default:""

Example:100

discount2AmountTotalnumber

Discount 2 amount total.

Default:""

Example:50

discount2AmountTotalCompanyCurrencynumber

Discount 2 amount total in company currency.

Default:""

Example:50

reportTokenstring

Report token for accessing the generated report.

Default:""

reportUrlstring

Report URL for the purchase order.

Default:""

Example:"https://reports.example.com/po/2024001"

reportNamestring

Report file name.

Default:""

Example:"PurchaseOrder_2024001.pdf"

emailSentboolean

Flag indicating if email was sent for this purchase order.

Default:false

Example:true

projectobject(ApiProjectListReadDto)

Associated project.

Default:""

Response

// No response example