Prepayments

Columns

Name

Type

Description

PrepaymentId [KEY]

String

The Id of the prepayment.

Date

Date

The date the prepayment was made.

Reference

String

A optional description for the payment.

Type

String

The prepayment type. The valid values are RECEIVE-PREPAYMENT and SPEND-PREPAYMENT.

RemainingCredit

Decimal

The remaining credit balance on the prepayment.

Contact_ContactId

String

The Id of the contact.

Contact_Name

String

The name of the contact.

Status

String

The status of the prepayment. Valid values are AUTHORISED, PAID, and VOIDED.

SubTotal

Decimal

The subtotal for the prepayment, which excludes taxes.

TotalTax

Decimal

The total tax for the prepayment.

Total

Decimal

The total for the prepayment, including tax -- the sum of SubTotal and TotalTax.

LineItem_LineItemId

String

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

The description for the line item. This field must contain at least 1 character and is required to create an approved invoice.

LineItem_Quantity

Double

The quantity of the associated item in the line item. This field is required for invoice approval and must be zero or positive.

LineItem_UnitAmount

Decimal

The unit amount of the associated item in the line item. This field is required for invoice approval.

LineItem_ItemCode

String

The code that identifies the associated item.

LineItem_AccountCode

String

The account code. This must be active for the organisation. This field is required for invoice approval.

LineItem_TaxType

String

The tax type. This field is used to override AccountCode, the default tax code for the selected account.

LineItem_TaxAmount

Decimal

The automatically calculated percentage of tax, based on the tax rate, for the line amount.

LineItem_LineAmount

Decimal

The total of the quantity multiplied by the unit amount with any discounts applied.

LineItem_TrackingCategory1_CategoryId

String

The Id of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory1_CategoryName

String

The name of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory1_OptionId

String

The Id of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory1_OptionName

String

The option of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory1_Option_Stat

String

The status of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory2_CategoryId

String

The Id of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory2_CategoryName

String

The name of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory2_OptionId

String

The Id of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory2_OptionName

String

The option of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_TrackingCategory2_Option_Stat

String

The status of a tracking category. The API allows two optional tracking categories to be defined.

LineItem_DiscountRate

Double

The discount percentage being applied to the line item. Discounts are only supported on ACCREC-type (sales) invoices.

LineAmountTypes

String

The LineAmount Type of the prepayment. Valid values are Exclusive, Inclusive, and NoTax.

CurrencyCode

String

Currency used for the prepayment.

CurrencyRate

String

The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used.

UpdatedDateUTC

Datetime

The date when the prepayment was last updated.

Allocation1_AppliedAmount

Decimal

The amount to be applied from this credit note to a given invoice.

Allocation1_Date

Date

The date the allocation was made.

Allocation1_InvoiceId

String

The Id of the invoice this allocation has been applied to.

Allocation1_InvoiceNumber

String

The Invoice this allocation has been applied to.

Allocation2_AppliedAmount

Decimal

The amount to be applied from this credit note to a given invoice.

Allocation2_Date

Date

The date the allocation was made.

Allocation2_InvoiceId

String

The Id of the invoice this allocation has been applied to.

Allocation2_InvoiceNumber

String

The Invoice this allocation has been applied to.

HasAttachments

Boolean

Boolean to indicate if a prepayment has an attachment.

TenantId

String

The ID of the tenant to query instead of the connection tenant

Last updated