Payrexx Octri Demo
PATCH/Bill/{id}/

Update an invoice

Updates an existing invoice with the fields you provide. Send only the invoice properties you want to change; id identifies the invoice to update. A 200 response returns the updated invoice object.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 24 body fields
idstringrequired
The identifier of the invoice to update.

Invoice properties to update. All fields are optional.

additionalRecipientsarray<string>optional
Send invoice to additional recipients. Pass email addresses as Strings.
applicationFeeintegeroptional
Amount in the smallest unit of the currency.
attachmentsarray<object>optional
Files to attach to the invoice; each attachment has a name and binary data.
bankInformationobjectoptional
Bank details for the invoice, including the IBAN, name, and address.
cashDiscountsarray<object>optional
Cash discount options, each with a number of days and a discount percentage.
completebooleanoptional
Whether to complete the invoice.
Default:false
currencystringoptional
Currency code (ISO 4217)
datestringoptional
Invoice date in YYYY-MM-DD format. Defaults to today when omitted.
Default:TODAY
designstringoptional
Identifier or value for the invoice design.
discountobjectoptional
Discount with an amount and a type of percent or amount; specify the amount in the currency's smallest unit when the type is amount.
dueAfterDaysintegeroptional
Number of days until the invoice is due: 5, 10, 20, 30, 40, 50, or 60.
Allowed:5102030405060
languagestringoptional
The language ISO code by ISO 639-1.
notestringoptional
Additional note for the invoice.
payoutDescriptorstringoptional
This payout descriptor is added to the payout statement (Only for Payrexx Swiss Collecting payments and single transaction payouts). Max. 80 chars.
pmarray<string>optional
Payment method names to use for the invoice.
positionsarray<object>optional
psparray<integer>optional
recipientobjectoptional
referencestringoptional
remindersarray<object>optional
sendbooleanoptional
Whether to send the invoice.
Default:false
servicePeriodobjectoptional
shippingCostintegeroptional
Amount in the smallest unit of the currency.
termsstringoptional

4 status codes
200Returns the updated invoice object, including its invoice details and payment link.
dataobjectoptional
metaobjectoptional
statusstringoptional
400Returned when a supplied value fails validation.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional
404Returned when the invoice cannot be found.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional
405Returned when the request method is not supported for the resource.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional

Error handling

A 400 is returned when a supplied value is invalid. A 404 is returned when the invoice identified by the id path parameter cannot be found. A 405 is returned when the request method is not supported. dueAfterDays must be one of 5, 10, 20, 30, 40, 50, or 60; payoutDescriptor must not exceed 80 characters.