QuickBooks: Read an attachable — response body — Attachable Attachable Ref item
Read an attachable: response body, field Attachable / AttachableRef / item. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read an attachable — response body — Attachable Attachable Ref item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
CustomField | array | Optional | If the user tries to fetch a record without permission, the permission denied message is conveyed through this field. |
CustomField[] | Model | Each item | Expand Read an invoice — response body — Invoice Custom Field item |
EntityRef | Model | Optional | Expand Read an item — response body — Item Class Ref Object reference to which this attachment is linked. Set EntityRef.value with the Id of the target object as returned in its response body when queried. Set EntityRef.type with the specific type of the target object. For example, invoice , bill , item , etc. |
Inactive | JSON | Optional | Indicates whether or not to include references to hidden entities when filtering. When set to true , hidden references are returned in the result set. For filtering results, it works with AttachableRef.EntityRef.Type , AttachableRef.EntityRef.Value and AttachableRef.NoRefOnly filters in combination. |
Inactive (anyOf 1) | boolean | Alternative | |
Inactive (anyOf 2) | string | Alternative | Known values: true, false |
IncludeOnSend | JSON | Optional | Used when EntityRef.type references a transaction object. This field indicates whether or not the attachment is sent with the transaction when Save and Send button is clicked in the QuickBooks UI or when the Send endpoint (send email) is invoked for the object. |
IncludeOnSend (anyOf 1) | boolean | Alternative | |
IncludeOnSend (anyOf 2) | string | Alternative | Known values: true, false |
LineInfo | string | Optional | For transaction objects, used to reference a transaction detail line. |
NoRefOnly | JSON | Optional | Indicates whether or not to find attachable records that have no references to any entity. Combine with AttachableRef.Inactive to return hidden references. |
NoRefOnly (anyOf 1) | boolean | Alternative | |
NoRefOnly (anyOf 2) | string | Alternative | Known values: true, false |
Referenced models: Read an invoice — response body — Invoice Custom Field item, Read an item — response body — Item Class Ref