Skip to content

List Attachments

Endpoint

http
GET /unified/accounting/attachments
Integrations supported
  • QuickBooks
  • Xero

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
Example: id
truto_ignore_limit
boolean
Ignores the `limit` query parameter.
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar
created_at
string · date-time
This represents the date when the attachment was created
Supported in
  • QuickBooks
updated_at
string · date-time
This represents the date when the attachment was updated
Supported in
  • QuickBooks
entity
string
The entity to get the fields for
All possible enum values:
  • account
  • contact
  • credit_note
  • invoice
  • purchase_order
Required in
  • Xero
entity_id
string
The unique identifier for entity's id. For example if entity is contacts, use contact id.
Required in
  • Xero

Response Body

result
object[]
List of Attachments
id
string
REQUIRED · The unique identifier for attachment
Supported in
  • QuickBooks
  • Xero
file_name
string
The name of the attachment
Supported in
  • QuickBooks
  • Xero
file_url
string
The url of the attachment
Supported in
  • QuickBooks
  • Xero
file_size
number
The size of the attachment
Supported in
  • QuickBooks
  • Xero
file_type
string
The MIME type of the attachment
Supported in
  • QuickBooks
  • Xero
parent
object
The parent object of the attachment
Supported in
  • QuickBooks
id
string
The unique identifier for the parent
type
string
The type of the parent
company
string
The company the attachment belongs to
created_at
string · date-time
This represents the date when the attachment was created
Supported in
  • QuickBooks
updated_at
string · date-time
This represents the date when the attachment was updated
Supported in
  • QuickBooks
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.