CreditNotes
Name | Type | ReadOnly | Description |
Id [KEY] | String | True | The line item index combined with the Id of the credit note. |
CreditNoteId | String | False | The Id of the credit note. |
CreditNoteNumber | String | False | A unique identifier for the credit note that identifies it to the user. |
Reference | String | False | An optional field to store a reference. |
Type | String | False | The credit note type. The valid values are ACCPAYCREDIT and ACCRECCREDIT. |
Contact_ContactId | String | False | The Id of the contact. |
Contact_Name | String | False | The name of the contact. |
Date | Date | False | The date the credit note was created. |
Status | String | False | The status of the credit note. |
LineAmountTypes | String | False | The line amount type, which determines whether line amounts include tax (default). The valid values are Exclusive, Inclusive, and NoTax. Credit notes cannot be approved without this field being defined. |
LineItem_LineItemId | String | False | The Xero generated identifier for a LineItem. If LineItemIDs are not included with line items in an update request then the line items are deleted and recreated. |
LineItem_Description | String | False | The description for the line item of the credit note. This value must be at least one character. Invoices cannot be approved without these fields. |
LineItem_Quantity | Double | False | The quantity of the subject of the line item. This value must be greater than or equal to 0. Invoices cannot be approved without these fields. |
LineItem_UnitAmount | Decimal | False | The unit amount of the subject of the line item. Invoices cannot be approved without these fields. |
LineItem_ItemCode | String | False | The user-defined item code. |
LineItem_AccountCode | String | False | The account code. The account code must be active for the organisation. Invoices cannot be approved without these fields. |
LineItem_Item_ItemId | String | False | The ID of the item the lineitem refers to. |
LineItem_Item_Name | String | False | The name of the item the lineitem refers to. |
LineItem_Item_Code | String | False | The code of the item the lineitem refers to. |
LineItem_TaxType | String | False | The description for the line item of the credit note. This value must be at least one character. Invoices cannot be approved without these fields. |
LineItem_TaxAmount | Decimal | False | The quantity of the subject of the line item. This value must be greater than or equal to 0. Invoices cannot be approved without these fields. |
LineItem_LineAmount | Decimal | False | The total of the Quantity field multiplied by the UnitAmount field with discounts applied. |
LineItem_TrackingCategory1_CategoryId | String | False | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory1_CategoryName | String | False | The name of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory1_OptionId | String | False | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory1_OptionName | String | False | The option of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory1_Option_Stat | String | False | The status of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory2_CategoryId | String | False | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory2_CategoryName | String | False | The name of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory2_OptionId | String | False | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory2_OptionName | String | False | The option of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_TrackingCategory2_Option_Stat | String | False | The status of a tracking category. The API allows two optional tracking categories to be defined. |
LineItem_DiscountRate | Double | False | The discount percentage being applied to the line item. Discounts are only supported on ACCREC-type credit notes. |
LineItemAggregate | String | False | Used to define LineItem rows using XML values. Should be provided on INSERT only. |
SubTotal | Decimal | False | The subtotal of the credit note, excluding taxes. |
TotalTax | Decimal | False | The total tax on the credit note. |
Total | Decimal | False | The total of the credit note (the subtotal plus the total tax). |
UpdatedDateUTC | Datetime | True | The date when the credit note was last updated. |
CurrencyCode | String | False | The currency used for the credit note. |
FullyPaidOnDate | Date | False | The date when the credit note was fully paid. |
SentToContact | Boolean | False | This field indicates whether the credit note has been sent to the contact via the Xero app. |
BrandingThemeId | String | False | The Id of the branding theme. |
CurrencyRate | Decimal | False | Exchange rate to base currency when money is spent or received. For example, 0.7500. This field is used for only bank transactions not in the base currency. If this is not specified for non-base-currency accounts then either the user-defined rate or the XE.com daily rate will be used. |
RemainingCredit | Decimal | False | The remaining credit for this credit note. |
Allocation1_AppliedAmount | Decimal | True | The amount to be applied from this credit note to a given invoice. |
Allocation1_Date | Date | True | The date the allocation was made. |
Allocation1_InvoiceId | String | True | The Id of the invoice this allocation has been applied to. |
Allocation1_InvoiceNumber | String | True | The Invoice this allocation has been applied to. |
Allocation2_AppliedAmount | Decimal | True | The amount to be applied from this credit note to a given invoice. |
Allocation2_Date | Date | True | The date the allocation was made. |
Allocation2_InvoiceId | String | True | The Id of the invoice this allocation has been applied to. |
Allocation2_InvoiceNumber | String | True | The Invoice this allocation has been applied to. |
HasAttachments | Boolean | True | This field indicates whether the invoice has an attachment. |
TenantId | String | False | The ID of the tenant to query instead of the connection tenant |
Last updated