AttachableRefs
Provides references linking transactions or entities to attached files or documents, helping you trace how uploaded attachments relate to bills, invoices, or other QuickBooks objects.
Table Specific Information
Select
All filterable columns support the following operators:
- =
- !=
- >=
- <=
- >
- <
- IN
- LIKE
- CONTAINS
The driver processes other filters client-side within the driver.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| EntityRefId [KEY] | String | True | True | False |
The unique identifier (Id) of the entity (such as an invoice, bill, or customer record) to which the attachment is linked in QuickBooks Online. | |
| AttachableId [KEY] | String | True |
Attachables.ID | True | True |
The unique Id that is assigned to the attachment itself, used to reference or update the attachable record. |
| SyncToken | String | True | False | False |
The version control token for the attachable record. This token must be included when the record is updated or deleted to ensure that you are working with the most recent version. | |
| MetaData_CreateTime | Datetime | True | True | True |
The date and time when the attachment record was created in QuickBooks Online. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the attachment record was last updated, enabling change tracking. | |
| FileName | String | False | True | True |
The name of the attached file as stored in QuickBooks Online, including its original filename if provided. | |
| Size | Integer | False | True | True |
The file size of the attachment in bytes, which can help with upload limits and storage considerations. | |
| ContentType | String | False | True | True |
The content type of the attached file (such as image/png, application/pdf) that indicates its format. | |
| Category | String | False | True | True |
The user-defined category of the attachment (for example, receipt, contract, or image) to help classify supporting documents. | |
| Latitude | Double | False | True | True |
The latitude coordinate where the attachment was uploaded or noted, if location data is available. | |
| Longitude | Double | False | True | True |
The longitude coordinate where the attachment was uploaded or noted, if location data is available. | |
| Note | String | False | True | True |
A free-text note stored either alongside the attachment or as a standalone comment, providing additional context or instructions. | |
| PlaceName | String | False | True | True |
The descriptive place name or location string that is associated with the upload, offering a human-readable location for the attachment. | |
| Tag | String | False | True | True |
A tag or label that is applied to the attachment to make searching and grouping easier. | |
| AttachableRef_EntityRef | String | False | True | False |
The reference value of the entity (such as an invoice Id) to which the attachment is linked, establishing the relationship between the attachment and a QuickBooks record. | |
| AttachableRef_EntityRef_type | String | False | True | False |
The type of entity that is referenced (such as Invoice, Bill, or Customer). For insert and update operations, this value is ignored when the AttachableRef_EntityRef column is null. | |
| AttachableRef_EntityRef_name | String | False | False | False |
The display name of the entity that is referenced. For insert and update operations, this value is ignored when the AttachableRef_EntityRef column is null. | |
| AttachableRef_IncludeOnSend | Boolean | False | True | False |
Indicates whether the attachment should be included when QuickBooks Online sends an email to a customer along with a transaction. | |
| AttachableRef_LineInfo | String | False | True | False |
If the entity is a transaction, this field specifies the transaction detail line (such as a specific invoice line) to which the attachment relates. | |
| FileAccessUri | String | False | False | False |
The complete Uniform Resource Identifier (URI) that can be used to access the attachment file within QuickBooks Online. | |
| TempDownloadUri | String | False | False | False |
The temporary URI that can be used by clients to directly download the attachment file without additional authentication. | |
| AttachableRef_NoRefOnly | Boolean | False | False | False |
Indicates whether to return only attachments that are not linked to any entity. This field can be combined with the AttachableRef.Inactive filter to return hidden or orphaned attachments. | |
| AttachableRef_Inactive | Boolean | False | False | False |
Indicates whether to include references to hidden entities when filtering. When this field is set to true, hidden references are included, and it works in combination with the AttachableRef.EntityRef.Type, AttachableRef.EntityRef.Value, and AttachableRef.NoRefOnly filters. | |
| AttachableRef_CustomFieldAggregate | String | False | False | False |
An XML aggregate that contains any custom field data that is associated with the attachment, enabling retrieval of extended metadata. |