Attachment folders

Folders are used to store attachments for easy grouping. For example, you can create an attachment folder for a project and store every supporting document for the project in that folder.

Attachment folders can be nested. The folder hierarchy can be as broad or deep as needed.

List folders

get/objects/company-config/folder

Returns a collection with a key, ID, and link for each folder. This operation is mostly for use in testing; use the query service to find folders that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Bills",
      • "href": "/objects/company-config/folder/1"
      },
    • {
      • "key": "2",
      • "id": "Credits",
      • "href": "/objects/company-config/folder/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a folder
post/objects/company-config/folder
Creates a new folder for attachments.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Folder to create


id
required
string
Unique name for the folder. Cannot be changed after the folder is created.


 
 Example:  "2024 Taxes"
description
string
Description of the folder.


 
 Example:  "2024 tax forms"
object
Parent folder, for folder hierarchies.


 
key
string
Unique key of the parent folder.


 
 Example:  "3"
id
string
Name of the parent folder.


 
 Example:  "fld3"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "2024 Bills",
  • "description": "Annual bills folder",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "28",
    • "id": "2024 Bills",
    • "href": "/objects/company-config/folder/28"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a folder
get/objects/company-config/folder/{key}
Returns detailed information for a specified folder.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for an attachment folder.


 
 Example:  28
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "28",
    • "id": "2024 Bills",
    • "parent": {
      • "id": "Bills",
      • "key": "2",
      • "href": "/objects/company-config/folder/2"
      },
    • "description": "Annual bills folder",
    • "audit": {
      • "createdDate": "2023-04-01",
      • "createdBy": "Admin",
      • "modifiedBy": "Admin",
      • "modifiedDate": "2023-04-01"
      },
    • "status": "active",
    • "hasSubfolders": false,
    • "href": "/objects/company-config/folder/28"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a folder
patch/objects/company-config/folder/{key}
Updates an existing folder by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for an attachment folder.


 
 Example:  28
Request Body schema: application/json
description
string
Description of the folder.


 
 Example:  "2024 tax forms"
object
Parent folder, for folder hierarchies.


 
key
string
Unique key of the parent folder.


 
 Example:  "3"
id
string
Name of the parent folder.


 
 Example:  "fld3"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "2024 bills and dunning notices"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Bills",
    • "href": "/objects/company-config/folder/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a folder
delete/objects/company-config/folder/{key}
Deletes a folder and all of its sub-folders and attachments. You must first remove the attachments from any objects or transactions.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for an attachment folder.


 
 Example:  28
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}