Classes

Class is a flexible dimension that can be defined in a company and used to track just about anything. You can rename the class dimension and add custom fields if needed, and then select a class and provide values for the fields in applicable transactions. You can use the data to create custom reports that provide important business insights.

Note that renaming the class dimension in the UI does not change the name of this object in the API. You still use class in API requests.

List classes

get/objects/company-config/class

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

Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, View Classes
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Class_1",
      • "href": "/objects/company-config/class/1"
      },
    • {
      • "key": "2",
      • "id": "Class_2",
      • "href": "/objects/company-config/class/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a class
post/objects/company-config/class
Creates a new class. You can think of this as adding a new value to the dimension that you can use to tag transactions for reporting.



Permissions and other requirements



SubscriptionCompany


User typeBusiness user with admin privileges


PermissionsAdd Classes







SecurityOAuth2 
Request 
Request Body schema: application/json
Class object to create


id
required
string
Unique ID for the class.


 
 Example:  "1-Goods"
name
required
string
Name of this class.


 
 Example:  "Goods"
description
string
Description of the class.


 
 Example:  "Goods available for donations"
status
string
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
object
Parent class, for class hierarchies.


 
id
string
Parent class ID.


 
 Example:  "23-Donations"
key
string
Parent class key.


 
 Example:  "4"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "SW",
  • "name": "Software",
  • "description": "All software titles",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "SW",
    • "href": "/objects/company-config/class/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a class
get/objects/company-config/class/{key}
Returns detailed information for a specified class.



Permissions and other requirements



SubscriptionCompany


User typeBusiness, Employee, Payment Approver


PermissionsList, View Classes







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the class.


 
 Example:  43
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "9",
    • "id": "SW-Office",
    • "name": "Office Software",
    • "description": "Office productivity software",
    • "status": "active",
    • "parent": {
      • "key": "8",
      • "id": "SW",
      • "name": "Software"
      },
    • "audit": {
      • "createdDateTime": "2022-06-28T23:41:44Z",
      • "modifiedDateTime": "2022-06-29T15:52:18Z",
      • "createdBy": "68",
      • "modifiedBy": "68"
      },
    • "href": "/objects/company-config/class/9"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a class
patch/objects/company-config/class/{key}
Updates an existing class by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionCompany


User typeBusiness user with admin privileges


PermissionsEdit Classes







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the class.


 
 Example:  43
Request Body schema: application/json
name
string
Name of this class.


 
 Example:  "Goods"
description
string
Description of the class.


 
 Example:  "Goods available for donations"
status
string
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
object
Parent class, for class hierarchies.


 
id
string
Parent class ID.


 
 Example:  "23-Donations"
key
string
Parent class key.


 
 Example:  "4"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "name": "Root one"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Class1",
    • "href": "/objects/company-config/class/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a class
delete/objects/company-config/class/{key}
Deletes a class. You can delete a class if it is not being used or referenced. Deleted classes cannot be recovered.



Permissions and other requirements



SubscriptionCompany


User typeBusiness user with admin privileges


PermissionsDelete Classes







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the class.


 
 Example:  43
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
    }
}
Query classes
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/class"
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/class",
  • "filters": [
    • {
      • "$ne": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "status",
    • "href",
    • "parent.key",
    • "parent.name"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "9",
      • "id": "SW Office",
      • "name": "Office Software",
      • "status": "active",
      • "href": "/objects/company-config/class/9",
      • "parent.key": "8",
      • "parent.name": "Software"
      }
    ],
  • "ia::meta": {
    • "totalCount": 1,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}