Creates a new draft credit note (avoir) in Altoviz. Credit notes are used to cancel or refund invoices. The credit note is created in draft status and can be modified before being finalized.
datestringDate of the credit note in YYYY-MM-DD format. If not provided, current date will be used.
linesarrayLine items for the credit note. Each line must include: description (string), quantity (number), type ('Product' or 'Service'), and either taxExcludedPrice or taxIncludedPrice depending on useTaxIncludedPrices setting.
regionRequiredstringTax region for this credit note. Must be one of: FR (France), EU (European Union), IE (Ireland), DOM (French overseas territories), Corse (Corsica), Monaco
subjectstringSubject/title for the credit note
vatModestringVAT mode: Auto (automatic), Debit (on invoice), or Collection (on payment)
vatNotestringVAT note to print on the credit note
metadataobjectAdditional metadata as key-value pairs
customerIdintegerCustomer ID to associate with this credit note. Either customerId or customerNumber must be provided. Use ALTOVIZ_FIND_CUSTOMER to look up customer IDs.
internalIdstringYour own internal reference ID for this credit note
footerNotesstringNotes to print in the footer section of the credit note
headerNotesstringNotes to print in the header section of the credit note
liableToVatbooleanIndicates whether the document is liable to VAT
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.