Xero Accounting Endpoint: AgedPayablesByContact
Overview
The Xero AgedPayablesByContact endpoint provides details of all outstanding supplier invoices for a given contact as at a specific date.
It is a function that accepts a series of parameters.
Parameters
The AgedPayablesByContactendpoint is a function that accepts the following parameters.
- ContactID
- A GUID field that determines the contact for which to produce values.
- This parameter is mandatory.
- Date
- A date field that determines the date for which to produce the report.
- This determines the cut-off date for payments.
- FromDate
- A date field that determines the start date for which to include invoices on the report.
- ToDate
- A date field that determines the end date for which to include invoices on the report.
Fields
The following fields are available for the BalanceSheet endpoint.
- ContactID
- A GUID field that indicates the contact for which to produce values.
- This will match the ContactID entered as parameter.
- Date
- A date field that indicates the date used to produce the values.
- This will match the Date entered as parameter.
- FromDate
- A date field that indicates the start date used to filter invoices.
- This will match the FromDate entered as parameter.
- ToDate
- A date field that indicates the end date used to filter invoices.
- This will match the ToDate entered as parameter.
- UpdatedDateUTC
- A date time field that indicates when the data was calculated.
- Lines
- A table field that provides the list of values.
- See Lines Fields for more information.
Lines Fields
The Lines Fields include the following sub fields.
- LineType
- A text field that indicates the type of line.
- Possible values are:
- Detail: Indicates the row contains the value of a given account.
- Total: Indicates the row contains a calculated value.
- InvoiceID
- A GUID field that provides the id of the invoice.
- This field can be used to link to the Invoices and InvoicesExpanded endpoints.
- This field will be set to null for rows whose LineType is not set to Detail.
- Reference
- A text field that provides the reference entered on the invoice.
- This field will be set to null for rows whose LineType is not set to Detail.
- Date
- A date field that indicates the date of the invoice.
- This field will be set to null for rows whose LineType is not set to Detail.
- DueDate
- A date field that indicates the due date of the invoice.
- This field will be set to null for rows whose LineType is not set to Detail.
- Total
- A decimal field that provides the total amount of the invoice or row.
- Paid
- A decimal field that provides the total amount paid on the invoice or row.
- Credited
- A decimal field that provides the total amount credited on the invoice or row.
- Due
- A decimal field that provides the total amount due on the invoice or row.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints