| Name | Type | Description | Notes |
|---|---|---|---|
| type | str | See Credit Note Types | [optional] |
| contact | Contact | [optional] | |
| date | date | The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation | [optional] |
| due_date | date | Date invoice is due – YYYY-MM-DD | [optional] |
| status | str | See Credit Note Status Codes | [optional] |
| line_amount_types | LineAmountTypes | [optional] | |
| line_items | list[LineItem] | See Invoice Line Items | [optional] |
| sub_total | float | The subtotal of the credit note excluding taxes | [optional] |
| total_tax | float | The total tax on the credit note | [optional] |
| total | float | The total of the Credit Note(subtotal + total tax) | [optional] |
| cis_deduction | float | CIS deduction for UK contractors | [optional] |
| cis_rate | float | CIS Deduction rate for the organisation | [optional] |
| updated_date_utc | datetime | UTC timestamp of last update to the credit note | [optional] |
| currency_code | CurrencyCode | [optional] | |
| fully_paid_on_date | date | Date when credit note was fully paid(UTC format) | [optional] |
| credit_note_id | str | Xero generated unique identifier | [optional] |
| credit_note_number | str | ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings) | [optional] |
| reference | str | ACCRECCREDIT only – additional reference number | [optional] |
| sent_to_contact | bool | Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved | [optional] |
| currency_rate | float | The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used | [optional] |
| remaining_credit | float | The remaining credit balance on the Credit Note | [optional] |
| allocations | list[Allocation] | See Allocations | [optional] |
| applied_amount | float | The amount of applied to an invoice | [optional] |
| payments | list[Payment] | See Payments | [optional] |
| branding_theme_id | str | See BrandingThemes | [optional] |
| status_attribute_string | str | A string to indicate if a invoice status | [optional] |
| has_attachments | bool | boolean to indicate if a credit note has an attachment | [optional] [default to False] |
| has_errors | bool | A boolean to indicate if a credit note has an validation errors | [optional] [default to False] |
| validation_errors | list[ValidationError] | Displays array of validation error messages from the API | [optional] |
| warnings | list[ValidationError] | Displays array of warning messages from the API | [optional] |
| invoice_addresses | list[InvoiceAddress] | An array of addresses used to auto calculate sales tax | [optional] |