XExeroapi
Files

Retrieves an association object using a unique object ID

Changed on

By passing in the appropriate options, you can retrieve an association

get/Associations/{ObjectId}

Request

  • Base URL
    https://api.xero.com/files.xro/1.0
  • URL
    https://api.xero.com/files.xro/1.0/Associations/{ObjectId}
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: files, files.read

Path parameters

ObjectIdstring uuid required
Example:4ff1e5cc-9835-40d5-bb18-09fdb118db9c

Object id for single object

Query parameters

pagesizeinteger
Example:50

pass an optional page size value

pageinteger
Example:2

number of records to skip for pagination

sort'Name' | 'Size' | 'CreatedDateUtc' | 'AssociationDateUtc'
Example:Associations/{ObjectId}?sort=CreatedDateUtc

values to sort by

direction'ASC' | 'DESC'
Example:Associations/{ObjectId}?sort=CreatedDateUtc&direction=DESC

direction to sort by

Response

search results matching criteria

SendWithObjectboolean

Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint.

Namestring

The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint.

Sizeinteger

The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint.

CreatedDateUtcstring date-time

The date the file was created (UTC). Note- The CreatedDateUtc element is only returned when using /Associations/{ObjectId} endpoint.

AssociationDateUtcstring date-time

The date the file was associated with the object (UTC). Note- The AssociationDateUtc element is only returned when using /Associations/{ObjectId} endpoint.

FileIdstring uuid

The unique identifier of the file

ObjectIdstring uuid

The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID)

ObjectGroup'Account' | 'BankTransaction' | 'Contact' | 'CreditNote' | 'Invoice' | 'Item' | 'ManualJournal' | 'Overpayment' | 'Payment' | 'Prepayment' | 'Quote' | 'Receipt'

The Object Group that the object is in. These roughly correlate to the endpoints that can be used to retrieve the object via the core accounting API.

ObjectType'Unknown' | 'Accpay' | 'AccPayCredit' | 'AccPayPayment' | 'AccRec' | 'AccRecCredit' | 'AccRecPayment' | 'Adjustment' | 'ApCreditPayment' | 'ApOverPayment' | 'ApOverPaymentPayment' | 'ApOverPaymentSourcePayment' | 'ApPrepayment' | 'ApPrepaymentPayment' | 'ApPrepaymentSourcePayment' | 'ArCreditPayment' | 'ArOverPayment' | 'ArOverpaymentPayment' | 'ArOverpaymentSourcePayment' | 'ArPrepayment' | 'ArPrepaymentPayment' | 'ArPrepaymentSourcePayment' | 'CashPaid' | 'CashRec' | 'ExpPayment' | 'ManJournal' | 'PurchaseOrder' | 'Receipt' | 'Transfer' | 'Account' | 'Contact' | 'Business' | 'Employee' | 'Person' | 'User' | 'Org' | 'FixedAsset' | 'PayRun' | 'PriceListItem' | 'Bank' | 'Current' | 'Equity' | 'Expense' | 'Fixed' | 'Liability' | 'Prepayment' | 'Revenue' | 'Sales' | 'Overheads' | 'Depreciatn' | 'OtherIncome' | 'DirectCosts' | 'Currliab' | 'Termliab' | 'NonCurrent' | 'SalesQuote'

The Object Type

Example response

[
  {
    "SendWithObject": true,
    "Name": "Test.pdf",
    "Size": 12357,
    "CreatedDateUtc": "2020-12-10T01:22:00.0000000",
    "AssociationDateUtc": "2020-12-10T01:22:00.0000000"
  }
]

Changes

  • a5ea94fb50fdRevision changes
    • breaking

      for the query request parameter sort, default value CreatedDateUtc was added

    • breaking

      removed the enum value CreatedDateUTC from the query request parameter sort

    • info

      added the new enum value AssociationDateUtc to the query request parameter sort

    • info

      added the new enum value CreatedDateUtc to the query request parameter sort

    • info

      added the new enum value Size to the query request parameter sort

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • bb86098f8245Revision changes
    • breaking

      added the new required header request parameter xero-tenant-id to all path's operations

    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status