Prepayments
Used to query prepayment records. Prepayments refer to money paid before goods or services are received.
Columns
| Name | Type | Description |
| PrepaymentId [KEY] | String | The unique identifier for the prepayment transaction. This ID links the prepayment to related transactions and helps in tracking it within the system. |
| Date | Date | The date when the prepayment was made. This is essential for recording the transaction date and helps with financial record-keeping. |
| Reference | String | An optional reference or description for the prepayment. This can be used to provide additional context or notes related to the prepayment transaction. |
| Type | String | The type of the prepayment. Valid values include 'RECEIVE-PREPAYMENT' (payment received in advance) and 'SPEND-PREPAYMENT' (advance payment made for a purchase). |
| RemainingCredit | Decimal | The remaining credit balance on the prepayment. This value shows how much of the prepayment is still available to be applied to future invoices. |
| Contact_ContactId | String | The identifier for the contact associated with the prepayment. This links the prepayment to a specific customer or supplier. |
| Contact_Name | String | The name of the contact associated with the prepayment. This helps identify the individual or organization involved in the transaction. |
| Status | String | The status of the prepayment. Valid values are 'AUTHORISED', 'PAID', and 'VOIDED', indicating the current state of the prepayment in the system. |
| SubTotal | Decimal | The subtotal for the prepayment, excluding taxes. This represents the base amount of the prepayment before taxes are applied. |
| TotalTax | Decimal | The total tax amount for the prepayment. This is calculated based on the applicable tax rates and is added to the subtotal to get the total value of the prepayment. |
| Total | Decimal | The total for the prepayment, including tax. This is the sum of the 'SubTotal' and 'TotalTax', representing the full amount of the prepayment. |
| LineItem_LineItemId | String | The unique identifier for the line item in the prepayment. This links the prepayment to specific line items within the transaction. |
| LineItem_Description | String | A description of the line item in the prepayment. This field must contain at least one character and is required for creating an approved invoice. |
| LineItem_Quantity | Double | The quantity of the item in the line item. This field is required for invoice approval and must be a zero or positive value. |
| LineItem_UnitAmount | Decimal | The unit price of the item in the line item. This value is required for invoice approval. |
| LineItem_ItemCode | String | The code that identifies the associated item. This links the prepayment to specific inventory or services. |
| LineItem_AccountCode | String | The account code used for the prepayment. The account must be active in the system and is required for invoice approval. |
| LineItem_TaxType | String | The tax type applied to the line item. This allows overriding the default tax code for the associated account, if necessary. |
| LineItem_TaxAmount | Decimal | The tax amount calculated for the line item. This is based on the tax type and is included in the total tax of the prepayment. |
| LineItem_LineAmount | Decimal | The total amount for the line item, calculated by multiplying the quantity by the unit amount and applying any discounts. |
| LineItem_TrackingCategory1_CategoryId | String | The identifier for the first tracking category associated with the line item. Tracking categories allow for further categorization of expenses. |
| LineItem_TrackingCategory1_CategoryName | String | The name of the first tracking category. This helps categorize the line item for reporting purposes. |
| LineItem_TrackingCategory1_OptionId | String | The identifier for the first tracking category option. This adds more granularity to the categorization of the line item. |
| LineItem_TrackingCategory1_OptionName | String | The name of the first tracking category option. This defines the specific option selected for the tracking category. |
| LineItem_TrackingCategory1_Option_Stat | String | The status of the first tracking category option. This reflects whether the option is active or inactive for reporting purposes. |
| LineItem_TrackingCategory2_CategoryId | String | The identifier for the second tracking category associated with the line item. |
| LineItem_TrackingCategory2_CategoryName | String | The name of the second tracking category for additional categorization of the line item. |
| LineItem_TrackingCategory2_OptionId | String | The identifier for the second tracking category option. This allows further classification of the line item. |
| LineItem_TrackingCategory2_OptionName | String | The name of the second tracking category option. This defines the specific option selected for the second tracking category. |
| LineItem_TrackingCategory2_Option_Stat | String | The status of the second tracking category option. This reflects whether the second tracking category option is active or inactive. |
| LineItem_DiscountRate | Double | The percentage discount applied to the line item. This is applicable to 'ACCREC' (sales) invoices and reduces the total amount due. |
| LineAmountTypes | String | Specifies the type of line amount for the prepayment. Valid values include 'Exclusive' (tax excluded), 'Inclusive' (tax included), and 'NoTax' (no tax applied). |
| CurrencyCode | String | The ISO 4217 currency code for the prepayment. This indicates the currency used in the transaction (for example, 'USD' or 'EUR'). |
| CurrencyRate | String | The exchange rate used for a multicurrency prepayment. If no rate is provided, the default XE.com day rate is used. |
| UpdatedDateUTC | Datetime | The timestamp of when the prepayment was last updated. This ensures that the data reflects the most current information. |
| Allocation1_AppliedAmount | Decimal | The amount of the prepayment applied to a given invoice. This is part of the allocation process, where the prepayment is used to reduce the invoice balance. |
| Allocation1_Date | Date | The date when the first allocation of the prepayment was made. This helps track when the prepayment was applied to the invoice. |
| Allocation1_InvoiceId | String | The identifier for the invoice to which the first allocation of the prepayment was applied. |
| Allocation1_InvoiceNumber | String | The invoice number for the first invoice receiving the prepayment allocation. |
| Allocation2_AppliedAmount | Decimal | The amount of the prepayment applied to a second invoice, if applicable. |
| Allocation2_Date | Date | The date when the second allocation of the prepayment was made. |
| Allocation2_InvoiceId | String | The identifier for the second invoice to which the prepayment was applied. |
| Allocation2_InvoiceNumber | String | The invoice number for the second invoice receiving the prepayment allocation. |
| PaymentIds | String | A comma-separated list of payment IDs associated with the prepayment. This tracks the payments that are linked to the prepayment. |
| HasAttachments | Boolean | Indicates whether the prepayment has any attachments, such as receipts or supporting documents. |
| TenantId | String | The unique identifier of the tenant. This ensures the query retrieves data specific to a particular tenant in a multi-tenant environment. |