Xero Files Endpoint: GetFileURL
Overview
The Xero GetFileURL endpoint provides URL you can use to download the file.
It is provided to simplify creating the DownloadFile function url.
It is a function that accepts a series of parameters.
Parameters
The GetFileURL 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.
- FileId
- A guid field that specifies the file id for which to download the file.
- This field is mandatory.
- FileName
- A text field that specifies the file name when downloading the file.
- This field is optional. When omitted, the file will be named as per the FileId field.
Fields
The following fields are available for the GetFileURL 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.
- Url
- A text field that provides the url to download the file.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints