Vendor GL groups

Vendor GL groups are categories of vendors grouped together so that transactions can be posted to specific GL accounts. Assign each vendor record to a vendor GL group. Finally, map the vendor GL group to GL accounts within transaction definitions.

List vendor GL groups

get/objects/purchasing/vendor-gl-group

Returns a collection with a key, ID, and link for each vendor GL group.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Auto VGL Group",
      • "href": "/objects/purchasing/vendor-gl-group/1"
      },
    • {
      • "key": "13",
      • "id": "VGL Group",
      • "href": "/objects/purchasing/vendor-gl-group/13"
      },
    • {
      • "key": "147",
      • "id": "Stationary VGL Group",
      • "href": "/objects/purchasing/vendor-gl-group/147"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a vendor GL group
post/objects/purchasing/vendor-gl-group
Creates a new vendor GL group.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name of the vendor GL group.


 
 Example:  "GL Group"
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": "Stationary VGL Group",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "VGL Group",
    • "href": "/objects/purchasing/vendor-gl-group/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a vendor GL group
get/objects/purchasing/vendor-gl-group/{key}
Returns detailed information for a specified vendor GL group.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "VGL Group",
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2024-10-22T07:37:32Z",
      • "modifiedDateTime": "2024-10-22T07:37:32Z",
      • "createdBy": "Admin",
      • "modifiedBy": "Admin"
      },
    • "href": "/objects/purchasing/vendor-gl-group/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a vendor GL group.
patch/objects/purchasing/vendor-gl-group/{key}
Updates an existing vendor GL group by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  99
Request Body schema: application/json
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
{
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "6",
    • "status": "active",
    • "href": "/objects/purchasing/vendor-gl-group/18"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a vendor GL group
delete/objects/purchasing/vendor-gl-group/{key}
Deletes a vendor GL group. Vendor GL groups can be deleted if they are not used by any transaction or are not assigned to any vendors. Deleting a vendor GL group removes it from the system.


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


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