AgedReceivablesByContact
Allows for querying aged receivables for a contact. It displays amounts owed to the organization by its customers, categorized by aging periods, helping track the overdue invoices.
Table-Specific Information
SELECT
If the ContactId is not provided, the Aged Receivables report for all contacts will be returned, one after the other. Please note that this will generate one operation against the Xero API per contact in the organization. Consider filtering to a subset of contacts or adding a LIMIT clause to avoid exceeding API limits. See Xero API Limits for more information.
Columns
| Name | Type | Description |
| ID [KEY] | String | A unique identifier for the row, created by combining the row number and the contact's ID. This ID is used to uniquely reference this particular entry. |
| ContactId | String | The unique identifier for the contact associated with this transaction or bill. This links the bill to a specific contact in the system. |
| Date | Datetime | The date when the invoice was created, marking the official creation date of the transaction. |
| Reference | String | The sale order reference number associated with this invoice. This helps to link the invoice to the corresponding sale order in the system. |
| DueDate | Datetime | The date by which payment for the invoice is due. This is the payment deadline for the amount specified in the invoice. |
| Overdue | Decimal | The amount that is still due after the 'DueDate' has passed. This represents the unpaid portion of the invoice that is now overdue. |
| Currency | String | The currency used for the amounts in this invoice, except for the 'DueLocal' amount. It will be empty if multi-currency is not enabled for the organization. |
| Total | Decimal | The total amount that is due for payment on this invoice. This includes the sum of all charges, fees, and adjustments. |
| Paid | Decimal | The total amount that has been paid towards this invoice. This is the sum of payments made against the total due amount. |
| Credited | Decimal | The amount that has been credited back to the account, possibly due to refunds, adjustments, or returned items, reducing the overall payable amount. |
| Due | Decimal | The remaining amount still owed, which is the 'Total' minus the 'Paid' and 'Credited' amounts. |
| DueLocal | Decimal | The amount still due, but converted into the organization's default currency. This field is used when the transaction involves multiple currencies. |
| TenantId | String | The unique identifier for the tenant, allowing you to query data for a specific tenant other than the default connection tenant. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| fromDate | Datetime | Filters and shows all payable invoices from the specified start date for the contact. This allows for date-based filtering on the results. |
| toDate | Datetime | Filters and shows all payable invoices up to the specified end date for the contact, allowing for a date range filter on the results. |