Xero Files Endpoint: GetFileDetails

Overview

The Xero GetFileDetails endpoint provides the details of the file uploaded to Xero, including the filename, size, type, etc.

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 GetFileDetails 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.
FileName
A text field that provides the filename of the file.
MimeType
A text field that provides the type of file uploaded to xero that follows the MIME standard.
Size
A number field that provides the size of the file in bytes.
CreatedDateUtc
A date time field that the date time the file was first uploaded.
UpdatedDateUtc
A date time field that the date time the file was last uploaded.
User
A record field that provides the details of the user that uploaded the file.
See User Fields for more information.


User Fields

The taxValues Fields include the following sub fields.

UserId
A guid field that provides the id of the user.
EmailAddress
A text field that provides the email address of the user.
FirstName
A text field that provides the first name of the user.
LastName
A text field that provides the last name of the user.
FullName
A text field that provides the full name of the user.


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Fields

DataFile


Related Endpoints

GetFileAssociations
GetFileURL
DownloadFile


Related Topics

Xero Files Models
Xero Files Endpoints