Item GL groups

Item GL groups are used to organize transaction definitions for posting to the general ledger.

List item GL groups

get/objects/inventory-control/item-gl-group

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "id": "OS GL Group",
      • "href": "/objects/inventory-control/item-gl-group/2"
      },
    • {
      • "key": "3",
      • "id": "Auto GL Group",
      • "href": "/objects/inventory-control/item-gl-group/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": 101,
    • "previous": null
    }
}
Create an item GL group
post/objects/inventory-control/item-gl-group
Creates a new item GL group.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name or other unique identifier for the item GL group.


 
 Example:  "Stockable Kit"
object
GL account to which to defer revenue for items belonging to this GL group.


 
key
string
System-assigned key for the deferred revenue GL account.


 
 Example:  "411"
id
string
Account number for the deferred revenue GL account.


 
 Example:  "1501.04"
object
Default revenue recognition template to use for deferred revenue for items belonging to this GL group.


 
key
string
System-assigned key for the revenue recognition template.


 
 Example:  "1"
id
string
Unique identifier for the revenue recognition template.


 
 Example:  "100"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Stockable Kit",
  • "deferredRevenueGLAccount": {
    • "key": "411",
    • "id": "1501.04",
    • "name": "Expense Account"
    },
  • "defaultRevenueRecognitionTemplate": {
    • "key": "1",
    • "id": "100"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "13",
    • "id": "Stockable Kit",
    • "href": "/objects/inventory-control/item-gl-group/13"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an item GL group
get/objects/inventory-control/item-gl-group/{key}
Returns detailed information for a specified item GL group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the item GL group.


 
 Example:  13
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "key": "13",
  • "id": "Stockable Kit",
  • "deferredRevenueGLAccount": {
    • "key": "411",
    • "id": "1501.04",
    • "name": "Expense Account",
    • "href": "/objects/general-ledger/account/411"
    },
  • "defaultRevenueRecognitionTemplate": {
    • "key": "1",
    • "id": "100",
    • "href": "/objects/accounts-receivable/revenue-recognition-template/1"
    },
  • "isSystemGenerated": false,
  • "href": "/objects/inventory-control/item-gl-group/13",
  • "audit": {
    • "createdDateTime": "2022-04-20T16:20:00Z",
    • "modifiedDateTime": "2022-04-20T16:20:00Z",
    • "createdBy": "1",
    • "modifiedBy": "95"
    }
}
Update an item GL group
patch/objects/inventory-control/item-gl-group/{key}
Updates an existing item GL group by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the item GL group.


 
 Example:  13
Request Body schema: application/json
object
GL account to which to defer revenue for items belonging to this GL group.


 
key
string
System-assigned key for the deferred revenue GL account.


 
 Example:  "411"
id
string
Account number for the deferred revenue GL account.


 
 Example:  "1501.04"
object
Default revenue recognition template to use for deferred revenue for items belonging to this GL group.


 
key
string
System-assigned key for the revenue recognition template.


 
 Example:  "1"
id
string
Unique identifier for the revenue recognition template.


 
 Example:  "100"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "id": "13",
  • "deferredRevenueGLAccount": {
    • "key": "411",
    • "id": "1501.04",
    • "name": "Expense Account"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "13",
    • "id": "Stockable Kit",
    • "href": "/objects/inventory-control/item-gl-group/13"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an item GL group
delete/objects/inventory-control/item-gl-group/{key}
Deletes a item GL group. An item GL group can be deleted if it has not been used by any transactions or assigned to any items.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the item GL group.


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