Vendor groups

A vendor group categorizes vendor dimension records, mainly for the purpose of structuring financial reports. For more information, see Vendor groups in the Sage Intacct Help Center.

List vendor groups

get/objects/accounts-payable/vendor-group

Returns a collection with a key, ID, and link for each vendor 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

200
400

application/json

{"ia::result": [{"key": "1",
"id": "Top Level Vendors",
"href": "/objects/accounts-payable/vendor-group/1"
},
{"key": "2",
"id": "1st Level Vendors",
"href": "/objects/accounts-payable/vendor-group/2"
},
{"key": "3",
"id": "2nd Level Vendors",
"href": "/objects/accounts-payable/vendor-group/3"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}

Create a vendor group

post/objects/accounts-payable/vendor-group

Creates a new vendor group.

SecurityOAuth2

Request

Request Body schema: application/json
required

Creates a new Vendor group.

id

required

string

Vendor group ID.

Example: "1"

name

required

string

Name of the vendor group.

Example: "Top level vendors"

description

string

Description of the vendor group.

Example: "Top-level vendor group"

groupType

string

Default: "allMembers"

Group membership type. The group type and related fields determine which vendors are included in the group. When creating reports that use vendors in rows or columns, these fields also determine the column headings and row headings that display, and the order in which they will be listed.

specificMembers - Specify the vendors to include and their order in the groupMembers array. You can optionally filter the array with the memberFilter settings.
allMembers - All vendors that match the memberFilter criteria.

Enum: "allMembers" "specificMembers"

Example: "allMembers"

object

One or more filters to select the vendors to include in the vendor group.

object

string

Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.

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 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)

Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records 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.

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"

Array of objects <= 1 items

Sort order for the results that match the filters when the group is displayed in reports. The entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.

Example: [{"id":"asc"}]

Array (<= 1 items)

property name*

additional property

string

Enum: "asc" "desc"

size

integer

The maximum number of records that match the filters to include in the group when it is displayed in reports.

Example: 100

Array of objects

List of vendors to include in the group when groupType is set to specificMembers.

Array

key	string Unique key for the vendor. Example: "12"
id	string Unique ID for the vendor. Example: "12"

isDimensionStructure

boolean

Default: false

Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.

Example: false

Responses

201

Created

400

Bad Request

Request samples

application/json

{"id": "1099 related vendors",
"name": "1099 related vendor group",
"description": "group of vendors who have 1099",
"groupType": "allMembers",
"isDimensionStructure": false,
"memberFilter": {"object": "accounts-payable/vendor",
"filterExpression": "and",
"filters": [{"$contains": {"id": 1099
}
}
],
"orderBy": [{"id": "asc"
}
]
}
}

Response samples

201
400

application/json

{"ia::result": {"key": "13",
"id": "1099 related vendors",
"href": "/objects/accounts-payable/accounts-payable-vendor-group/13"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Get a vendor group

get/objects/accounts-payable/vendor-group/{key}

Returns detailed information for a specified vendor group.

SecurityOAuth2

Request

path Parameters

key

required

string

System assigned unique key for the vendor group.

Example: 16

Responses

200

OK

400

Bad Request

Request samples

Response samples

200
400

application/json

{"ia::result": {"key": "3",
"id": "2nd Level Vendors",
"name": "Level 2 Vendors",
"description": "Level 2 Vendors",
"groupType": "specificMembers",
"audit": {"createdDateTime": "2016-06-28T17:56:21Z",
"modifiedDateTime": "2016-06-28T17:56:21Z",
"createdBy": "11",
"modifiedBy": "11"
},
"entity": {"id": "3",
"key": "3",
"href": "/objects/company-config/entity/3"
},
"groupMembers": [{"key": "12",
"id": "AUT",
"name": "Auto_Supplies Inc.",
"status": "active",
"sortOrder": "0",
"href": "/objects/accounts-payable/vendor/12"
},
{"key": "13",
"id": "CAL",
"name": "CALOIL Corporation",
"status": "active",
"sortOrder": "1",
"href": "/objects/accounts-payable/vendor/13"
}
],
"isDimensionStructure": false,
"memberFilter": {"object": "accounts-payable/vendor",
"filterExpression": "and",
"orderBy": [{"name": "asc"
}
]
},
"href": "/objects/accounts-payable/vendor-group/3"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Update a vendor group

patch/objects/accounts-payable/vendor-group/{key}

Updates an existing vendor 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 group.

Example: 16

Request Body schema: application/json

name

string

Name of the vendor group.

Example: "Top level vendors"

description

string

Description of the vendor group.

Example: "Top-level vendor group"

groupType

string

Default: "allMembers"

Group membership type. The group type and related fields determine which vendors are included in the group. When creating reports that use vendors in rows or columns, these fields also determine the column headings and row headings that display, and the order in which they will be listed.

specificMembers - Specify the vendors to include and their order in the groupMembers array. You can optionally filter the array with the memberFilter settings.
allMembers - All vendors that match the memberFilter criteria.

Enum: "allMembers" "specificMembers"

Example: "allMembers"

object

One or more filters to select the vendors to include in the vendor group.

object

string

Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.

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 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)

Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records 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.

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"

Array of objects <= 1 items

Sort order for the results that match the filters when the group is displayed in reports. The entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.

Example: [{"id":"asc"}]

Array (<= 1 items)

property name*

additional property

string

Enum: "asc" "desc"

size

integer

The maximum number of records that match the filters to include in the group when it is displayed in reports.

Example: 100

Array of objects

List of vendors to include in the group when groupType is set to specificMembers.

Array

key	string Unique key for the vendor. Example: "12"
id	string Unique ID for the vendor. Example: "12"

isDimensionStructure

boolean

Default: false

Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.

Example: false

Responses

200

OK

400

Bad Request

Request samples

application/json

{"description": "Group of vendors who have enabled 1099"
}

Response samples

200
400

application/json

{"ia::result": {"key": "15",
"id": "1099 related vendors",
"href": "/objects/accounts-payable/vendor-group/15"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Delete a vendor group

delete/objects/accounts-payable/vendor-group/{key}

Deletes a vendor group. Vendor groups that are not being used for reporting can be deleted.

SecurityOAuth2

Request

path Parameters

key

required

string

System assigned unique key for the vendor group.

Example: 16

Responses

204

No Content

400

Bad Request

Request samples

Response samples

400

application/json

{"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
}
}

Vendor groups

List vendor groups

Create a vendor group

Request Body schema: application/jsonrequired

Get a vendor group

path Parameters

Update a vendor group

path Parameters

Request Body schema: application/json

Delete a vendor group

path Parameters

Request Body schema: application/json
required