Xero Files Endpoint: GetFileAssociations
Jump to navigation
Jump to search
Overview
The Xero GetFileAssociations endpoint provides a list of all files (specifically the FileId field) associated with a given item. The item can be another other ID for any other data point (invoice, contact, payment, etc.).
This is the first function to use when using the Xero Files Model.
It is a function that accepts a series of parameters.
Parameters
The GetFileAssociations is a function that accepts the following parameters.
- DataFile
- A textfield that specified the data file for which to retrieve the list of files.
- This field is only included when using a Consolidation Odata Feed.
- This field is mandatory.
- ObjectID
- A guid field that specifies the item for which to retrieve the list of files.
- This field is mandatory.
Fields
The following fields are available for the GetFileAssociations endpoint.
- DataFile
- A record field that provides the DataFile associated with the asset type.
- FileId
- A guid field that provides the id of the file.
- ObjectId
- A guid field that provides the id of the object (Invoice, Contact, Payment, etc.).
- ObjectType
- A text field that provides the type of the object (Invoice, Contact, Payment, etc.).
- ObjectGroup
- A text field that provides the group of the object (Invoice, Contact, Payment, etc.).
- SendWithObject
- A true/false field that indicates if the file is sent with the object (e.g. sent with the invoice).
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints