Nic: Created page with "== Overview == The Xero '''AgedPayablesByContact''' endpoint provides details of all outstanding supplier invoices for a given contact as at a s..."

2021-12-17T00:19:56Z

Created page with "== Overview == The Xero '''AgedPayablesByContact''' endpoint provides details of all outstanding supplier invoices for a given contact as at a s..."

New page

== Overview ==

The Xero '''AgedPayablesByContact''' [[Xero Accounting Endpoints|endpoint]] provides details of all outstanding supplier invoices for a given contact as at a specific date.

It is a [[Function Endpoints|function]] that accepts a series of parameters.

== Parameters ==

The AgedPayablesByContactendpoint is a [[Function Endpoints|function]] that accepts the following parameters.

;ContactID
:A [[Field Type: GUID|GUID field]] that determines the contact for which to produce values.
:This parameter is mandatory.

;Date
:A [[Field Type: Date|date field]] that determines the date for which to produce the report.
:This determines the cut-off date for payments.

;FromDate
:A [[Field Type: Date|date field]] that determines the start date for which to include invoices on the report.

;ToDate
:A [[Field Type: Date|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 [[Field Type: GUID|GUID field]] that indicates the contact for which to produce values.
:This will match the ContactID entered as [[#Parameters|parameter]].

;Date
:A [[Field Type: Date|date field]] that indicates the date used to produce the values.
:This will match the Date entered as [[#Parameters|parameter]].

;FromDate
:A [[Field Type: Date|date field]] that indicates the start date used to filter invoices.
:This will match the FromDate entered as [[#Parameters|parameter]].

;ToDate
:A [[Field Type: Date|date field]] that indicates the end date used to filter invoices.
:This will match the ToDate entered as [[#Parameters|parameter]].

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates when the data was calculated.

;Lines
:A [[Field Type: Table|table field]] that provides the list of values.
:See [[#Lines Fields|Lines Fields]] for more information.

== Lines Fields ==

The [[#Fields|Lines Fields]] include the following sub fields.

;LineType
:A [[Field Type: Text|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 [[Field Type: GUID|GUID field]] that provides the id of the invoice.
:This field can be used to link to the [[Xero Accounting Endpoint: Invoices|Invoices]] and [[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] endpoints.
:This field will be set to null for rows whose '''LineType''' is not set to '''Detail'''.

;Reference
:A [[Field Type: Text|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 [[Field Type: Date|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 [[Field Type: Date|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 [[Field Type: Decimal|decimal field]] that provides the total amount of the invoice or row.

;Paid
:A [[Field Type: Decimal|decimal field]] that provides the total amount paid on the invoice or row.

;Credited
:A [[Field Type: Decimal|decimal field]] that provides the total amount credited on the invoice or row.

;Due
:A [[Field Type: Decimal|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 [https://developer.xero.com/documentation/api/accounting/reports##aged-payables-by-contact Xero API].

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: Invoices|Invoices]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]

== Related Topics ==

:[[Xero Accounting Models]]
:[[Xero Accounting Endpoints]]

Xero Accounting Endpoint: AgedPayablesByContact - Revision history

Nic: Created page with "== Overview == The Xero '''AgedPayablesByContact''' endpoint provides details of all outstanding supplier invoices for a given contact as at a s..."