Account group purposes

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 and then assign them to account groups when you create or update the groups.

List account group purposes

get/objects/general-ledger/account-group-purpose

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.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create an account group purpose
post/objects/general-ledger/account-group-purpose
Creates a new account group purpose.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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.


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


400
Bad Request


Request samples 
application/json
{
  • "id": "Budget1",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "35",
    • "id": "Budget1",
    • "href": "/objects/general-ledger/account-group-purpose/35"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an account group purpose
get/objects/general-ledger/account-group-purpose/{key}
Returns detailed information for a specified account group purpose.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account group purpose.


 
 Example:  3906
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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
    }
}
Update an account group purpose
patch/objects/general-ledger/account-group-purpose/{key}
Updates an existing account group purpose by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account group purpose.


 
 Example:  3906
Request Body schema: application/json
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.


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


400
Bad Request


Request samples 
application/json
{
  • "id": "Budgeted Expenses"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "35",
    • "id": "Budgeted Expenses",
    • "href": "/objects/general-ledger/account-group-purpose/35"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an account group purpose
delete/objects/general-ledger/account-group-purpose/{key}
Deletes an account group purpose.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account group purpose.


 
 Example:  3906
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
    }
}