Update a credit note

patch

https://api.piriod.com/purchase/credit-notes/{id}/

Updates a Credit Notes object. Only credit notes with status draft can be updated.

Path Params

string

required

The unique ID of the Credit Note you want to update

Body Params

date

Credit note issuance date (YYYY-MM-DD format).

discount

float

Defaults to 0

Total discount applied to the credit note.

discount_scheme

string

enum

Defaults to %

Indicates if the discount is applied as a percentage % or a fixed amount $.

Allowed:

internal_note

string

Optional internal note for reference (not shown on document).

lines

object

List of line items being credited. Follows the same structure as purchase lines.

metadata

json

A freely usable key/value object. Useful for storing custom information.

note

string

Public note to display reason on the credit note.

number

int32

Credit note number. If omitted, it will be auto-generated.

purchase

string

ID of the original purchase being credited.

tax_settings

object

Fields used to define tax aspects specific to the different electronic invoicing regulations of each country.

test_mode

string

Determines whether the Credit Note is for test use or not

Responses

200200