Attachment folders

Folder 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.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List folders

get/objects/company-config/folder

Returns up to 100 folders from the 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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList Attachment Folders
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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsAdd Attachment Folders
SecurityOAuth2
Request
Request Body schema: application/json

Folder to create

id
required
string

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

Example: "2022 Tax forms"
description
string

Description of the folder

Example: "2022 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"
object
key
string
Example: "30"
id
string
Example: "Seattle"
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": "2022 Bills",
  • "description": "Annual bills folder",
  • "status": "active"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "28",
    • "id": "2022 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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsView Attachment Folders
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the attachment folder.

Example: 28
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "28",
    • "id": "2022 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",
    • "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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsEdit Attachment Folders
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the attachment folder.

Example: 28
Request Body schema: application/json
description
string

Description of the folder

Example: "2022 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"
object
key
string
Example: "30"
id
string
Example: "Seattle"
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": "2022 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 subfolders and attachments. You must first remove the attachments from any records or transactions.

Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsDelete Attachment Folders
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the attachment folder.

Example: 28
Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "Payload contains errors",
      • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
      • "errorId": "REST-1064",
      • "additionalInfo": {
        },
      • "details": [
        ]
      },
    • "ia::meta": {
      • "totalCount": 3,
      • "totalSuccess": 2,
      • "totalError": 1
      }
    },
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}

Query folders

post/services/core/query

Queries an object for filtered data.

SecurityOAuth2
Request
Request Body schema: application/json
object
string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "company-config/folder"
fields
Array of strings

List of fields to include in the response. Can be any combination of these:

  • The name of a field in the object that you are querying, such as id.

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:

    • count
    • avg
    • sum
    • min
    • max
  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

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 asOfDate in filterParameters, if set:

  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}
filterExpression
string
Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

  • and by itself means that all conditions must be true.
  • or by itself means that at least one condition must be true.
Example: "(1 and 2) or 3"
object

Pre-defined filter options.

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2022-04-01"
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includePrivate
boolean
Default: false

By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
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
property name*
additional property
string
Enum: "asc" "desc"
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
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "object": "company-config/folder",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "parent.key",
    • "status",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "id": "Invoice Docs",
      • "parent.key": "1",
      • "status": "active",
      • "href": "/objects/company-config/folder/2"
      },
    • {
      • "key": "1",
      • "id": "Recurring Transactions",
      • "parent.key": "1",
      • "status": "active",
      • "href": "/objects/company-config/folder/1"
      },
    • {
      • "key": "9",
      • "id": "SW",
      • "parent.key": "1",
      • "status": "active",
      • "href": "/objects/company-config/folder/9"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}