An attachment object contains an array of one more or more files that are stored in Sage Intacct. You can attach multiple files of any type to a transaction using an attachment, such as scanned images, spreadsheets, and word-processor documents. For example, you might add ten scanned images to a single attachment for a bill.
It's important to note that each transaction or record can only have one attachment assigned to it. After you add an attachment, you can add or delete individual files to and from the attachment, ensuring your supporting documents are always up-to-date.
All attachments are stored in attachment folders.
Returns up to 100 attachments from the collection with a key, ID, and link for each attachment. This operation is mostly for use in testing; use the query service to find attachments that meet certain criteria and specify the properties that are returned.
Subscription | Company |
---|---|
User type | Business, Employee, Project Manager, Platform, and Warehouse |
Permissions | List Attachments |
OK
Bad Request
{- "ia::result": [
- {
- "key": "8",
- "id": "PROJ-159",
- "href": "/objects/company-config/attachment/8"
}, - {
- "key": "1",
- "id": "INVOICES",
- "href": "/objects/company-config/attachment/1"
}, - {
- "key": "2",
- "id": "2022 Taxes",
- "href": "/objects/company-config/attachment/2"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new attachment in a specified folder. You can add files when you create an attachment, or use a PATCH request to add files later.
Subscription | Company |
---|---|
User type | Business |
Permissions | Add Attachments |
Attachment to create
id required | string Unique ID for the attachment container. Example: "2022 Taxes" | ||||||||
name | string Brief name for the attachment container. Example: "2022 tax forms" | ||||||||
object Folder that this attachment is in. | |||||||||
| |||||||||
description | string Description of the attachment container. Example: "February invoices" | ||||||||
object | |||||||||
| |||||||||
Array of objects Files contained in the attachment. | |||||||||
Array
| |||||||||
object | |||||||||
Created
Bad Request
{- "id": "2022 Tax",
- "name": "2022 Tax Forms",
- "folder": {
- "key": "27"
}
}
{- "ia::result": {
- "key": "17",
- "id": "2022 Tax",
- "href": "/objects/company-config/attachment/17"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified attachment, including Base64-encoded versions of all files in the attachment.
Subscription | Company |
---|---|
User type | Business, Employee, Project Manager, Platform, and Warehouse |
Permissions | List Attachments |
key required | string System-assigned key for the attachment. Example: 43 |
OK
Bad Request
{- "ia::result": {
- "key": "17",
- "id": "INV-V1",
- "name": "Vendor 1 Invoices",
- "folder": {
- "id": "Invoices",
- "key": "1",
- "href": "/objects/company-config/folder/1"
}, - "description": null,
- "audit": {
- "createdBy": "matthew.mikawber",
- "modifiedBy": "matthew.mikawber",
- "modifiedDate": "2023-05-25",
- "createdDate": "2023-05-25"
}, - "files": [
- {
- "id": "29",
- "key": "29",
- "attachment": {
- "key": "17"
}, - "data": "aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ==",
- "name": "short file.txt",
- "size": 40
}
], - "href": "/objects/company-config/attachment/17"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing attachment by setting field values. Any fields not provided remain unchanged. Use this operation to add, update, and delete files in attachments.
Subscription | Company |
---|---|
User type | Business |
Permissions | Edit Attachments |
key required | string System-assigned key for the attachment. Example: 43 |
name | string Brief name for the attachment container. Example: "2022 tax forms" | ||||||||
object Folder that this attachment is in. | |||||||||
| |||||||||
description | string Description of the attachment container. Example: "February invoices" | ||||||||
object | |||||||||
| |||||||||
Array of objects Files contained in the attachment. | |||||||||
Array
| |||||||||
object | |||||||||
OK
Bad Request
{- "files": [
- {
- "name": "short file 2.txt",
- "data": "aGVsbG8gd29ybGQhIHRoaXMgaXMgYmFzZTY0IGVuY29kZWQgZGF0YQ=="
}
]
}
{- "ia::result": {
- "key": "17",
- "id": "attach-02",
- "href": "/objects/company-config/attachment/17"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a attachment and all files that it contains. You must first remove the attachment from any records or transactions.
Subscription | Company |
---|---|
User type | Business, Employee, Project Manager, Platform, and Warehouse |
Permissions | List Attachments |
key required | string System-assigned key for the attachment. Example: 43 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "Payload contains errors",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "errorId": "REST-1064",
- "additionalInfo": {
- "messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
- "placeholders": { },
- "propertySet": { }
}, - "details": [
- {
- "code": "invalidRequest",
- "message": "/testDate is not a valid field",
- "errorId": "REST-1043",
- "target": "/testDate",
- "additionalInfo": {
- "messageId": "IA.NOT_A_VALID_FIELD",
- "placeholders": {
- "FIELD": "/testDate"
}, - "propertySet": { }
}
}
]
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}, - "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "company-config/attachment" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "company-config/attachment",
- "filters": [
- {
- "$contains": {
- "folder.id": "Invoice"
}
}
], - "fields": [
- "key",
- "id",
- "name",
- "folder.id",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "5",
- "id": "123",
- "name": "Sales support doc",
- "folder.id": "Invoice Docs",
- "href": "/objects/company-config/attachment/5"
}, - {
- "key": "8",
- "id": "59",
- "name": "InterestExpense",
- "folder.id": "Invoice Docs",
- "href": "/objects/company-config/attachment/8"
}, - {
- "key": "6",
- "id": "Sales 01",
- "name": "Sales support doc",
- "folder.id": "Invoice Docs",
- "href": "/objects/company-config/attachment/6"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}