Module credit_note

Structs§

CreateCreditNote: Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero. This amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:.
CreateCreditNoteLines: Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.
CreditNoteRefundParams
CreditNoteShippingCost
ListCreditNote: Returns a list of credit notes.
PreviewCreditNote: Get a preview of a credit note without creating it.
PreviewCreditNoteLines: Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.
PreviewLinesCreditNote: When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
PreviewLinesCreditNoteLines: Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.
RetrieveCreditNote: Retrieves the credit note object with the given identifier.
TaxAmountWithTaxRateParam
UpdateCreditNote: Updates an existing credit note.
VoidCreditNoteCreditNote: Marks a credit note as void. Learn more about voiding credit notes.

CreateCreditNoteEmailType: Type of email to send to the customer, one of credit_note or none and the default is credit_note.
CreateCreditNoteLinesType: Type of the credit note line item, one of invoice_line_item or custom_line_item
PreviewCreditNoteEmailType: Type of email to send to the customer, one of credit_note or none and the default is credit_note.
PreviewCreditNoteLinesType: Type of the credit note line item, one of invoice_line_item or custom_line_item
PreviewLinesCreditNoteEmailType: Type of email to send to the customer, one of credit_note or none and the default is credit_note.
PreviewLinesCreditNoteLinesType: Type of the credit note line item, one of invoice_line_item or custom_line_item