Account group purposes let you filter account groups according to why you might use them, which is particularly useful in financial reporting. You create account group purposes, which you can then specify when creating or updating your account groups.
Returns a collection with a key, ID, and link for each purpose. This operation is mostly for use in testing; use the query service to find account group purposes that meet specific criteria and to specify the properties that you want in the response.
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "Budgeted Expenses",
- "href": "/objects/general-ledger/account-group-purposes/19"
}, - {
- "key": "2",
- "id": "Capital Expenses",
- "href": "/objects/general-ledger/account-group-purposes/21"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new account group purpose.
Account group purpose to create
id required | string Name for the account group purpose. Example: "P&L" |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
Created
Bad Request
{- "id": "Budget1",
- "status": "active"
}
{- "ia::result": {
- "key": "35",
- "id": "Budget1",
- "href": "/objects/general-ledger/account-group-purpose/35"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified account group purpose.
key required | string System-assigned key for the account group purpose. |
OK
Bad Request
{- "ia::result": {
- "id": "P&L - New",
- "status": "active",
- "key": "32",
- "audit": {
- "createdDateTime": "2021-02-22T16:30:48Z",
- "modifiedDateTime": "2021-02-22T16:30:48Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/general-ledger/account-group-purpose/32"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing account group purpose by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the account group purpose. |
id | string Name for the account group purpose. Example: "P&L" |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
OK
Bad Request
{- "id": "Budgeted Expenses"
}
{- "ia::result": {
- "key": "35",
- "id": "Budgeted Expenses",
- "href": "/objects/general-ledger/account-group-purpose/35"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an account group purpose.
key required | string System-assigned key for the account group purpose. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "general-ledger/account-group-purpose" | ||||||||
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": "general-ledger/account-group-purpose",
- "filters": [
- {
- "$eq": {
- "status": "active"
}
}
], - "fields": [
- "key",
- "id",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "15",
- "id": "Capital Expenses",
- "href": "/objects/accounts-payable/account-label/15"
}, - {
- "key": "17",
- "id": "Budgeted expenses",
- "href": "/objects/accounts-payable/account-label/17"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}