Affiliate entity groups

A collection of associated entities that form a reporting group. For example, entities E200 and E500 may be associated with the parent entity E100.

List affiliate entity groups

get/objects/company-config/affiliate-entity-group

Returns a collection with a key, ID, and link for each affiliate entity group. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionCompany
User typeBusiness
PermissionsList, View Affiliate Entity Groups
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "3",
      • "id": "u",
      • "href": "/objects/company-config/affiliate-entity-group/3"
      },
    • {
      • "key": "1",
      • "id": "Aff_Grp_USA",
      • "href": "/objects/company-config/affiliate-entity-group/1"
      },
    • {
      • "key": "2",
      • "id": "Aff_Group_Other",
      • "href": "/objects/company-config/affiliate-entity-group/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an affiliate entity group
post/objects/company-config/affiliate-entity-group
Creates a new affiliate entity group.



Permissions and other requirements



SubscriptionCompany


User typeBusiness


PermissionsList, View, Add Affiliate Entity Groups







SecurityOAuth2 
Request 
Request Body schema: application/json
Creates a new affiliate entity group.


id
required
string
Unique identifier for the affiliate entity group.


 
 Example:  "AF"
name
required
string
Name for the affiliate entity group.


 
 Example:  "MariposaBusinessEntities"
description
string
Description for the affiliate entity group.


 
 Example:  "E100 E200 E500 affiliate entity group"
groupType
string
 Default:  "all"
Group membership type. Use groupType to select the affiliate entities that you want to include in financial reports when filtering on an affiliate entity group. You can also select the column and row headings and the order in which they will appear in your reports.


    

  • specific - Select to specify the affiliate entities that you want to include and the order in which they will appear in the members array.
    • 

  • all - Select to filter for all affiliate entities that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "specific"
isDimensionStructure
boolean
 Default:  false
When selected, creating a dimension structure from a group enables you to add the group to the rows or columns of a financial report.


 
 Example:  false
object
One or more filters to select the vendors to include in the vendor group.


 
object
string
Object type to filter on.


 
 Example:  "accounts-payable/vendor"
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)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects 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. Each 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
An array that lists members of the affiliate entity group by key, entity ID, endpoint, and name with an option to sort.


 
 Array 
key
string
Unique key for the affiliate entity.


 
 Example:  "23"
id
string
Unique identifier for the affiliate entity.


 
 Example:  "E200"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Aff_3M",
  • "name": "Aff_Grp_specific",
  • "description": "affiliate group with 3 members",
  • "groupType": "specific",
  • "groupMembers": [
    • {
      • "id": "2"
      },
    • {
      • "id": "1"
      },
    • {
      • "id": "GM"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "9",
    • "id": "Aff_3M",
    • "href": "/objects/company-config/affiliate-entity-group/9"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an affiliate entity group
get/objects/company-config/affiliate-entity-group/{key}
Returns detailed information for a specified affiliate entity group.



Permissions and other requirements



SubscriptionCompany


User typeBusiness


PermissionsList, View Affiliate Entity Groups







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the affiliate entity group.


 
 Example:  18
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "9",
    • "id": "Aff_3M",
    • "name": "Aff_Grp_specific",
    • "description": "affiliate group with 3 members",
    • "groupType": "specific",
    • "memberFilter": [ ],
    • "audit": {
      • "createdDateTime": "2024-08-07T11:44:26Z",
      • "modifiedDateTime": "2024-08-07T11:44:26Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "groupMembers": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "href": "/objects/company-config/affiliate-entity-group/9"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an affiliate entity group
patch/objects/company-config/affiliate-entity-group/{key}
Updates an existing affiliate entity group by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionCompany


User typeBusiness


PermissionsList, View, Edit Affiliate Entity Group







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the affiliate entity group.


 
 Example:  18
Request Body schema: application/json
Updates an affiliate entity group


name
string
Name for the affiliate entity group.


 
 Example:  "MariposaBusinessEntities"
description
string
Description for the affiliate entity group.


 
 Example:  "E100 E200 E500 affiliate entity group"
groupType
string
 Default:  "all"
Group membership type. Use groupType to select the affiliate entities that you want to include in financial reports when filtering on an affiliate entity group. You can also select the column and row headings and the order in which they will appear in your reports.


    

  • specific - Select to specify the affiliate entities that you want to include and the order in which they will appear in the members array.
    • 

  • all - Select to filter for all affiliate entities that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "specific"
isDimensionStructure
boolean
 Default:  false
When selected, creating a dimension structure from a group enables you to add the group to the rows or columns of a financial report.


 
 Example:  false
object
One or more filters to select the vendors to include in the vendor group.


 
object
string
Object type to filter on.


 
 Example:  "accounts-payable/vendor"
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)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects 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. Each 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
An array that lists members of the affiliate entity group by key, entity ID, endpoint, and name with an option to sort.


 
 Array 
key
string
Unique key for the affiliate entity.


 
 Example:  "23"
id
string
Unique identifier for the affiliate entity.


 
 Example:  "E200"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "name": "Aff_Grp_specific",
  • "description": "Affiliate entity group udpated to member 1 only",
  • "groupType": "specific",
  • "groupMembers": [
    • {
      • "key": "1",
      • "id": "1"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "9",
    • "id": "Aff_3M",
    • "href": "/objects/company-config/affiliate-entity-group/9"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an affiliate entity group
delete/objects/company-config/affiliate-entity-group/{key}
Deletes an affiliate entity group.



Permissions and other requirements



SubscriptionCompany


User typeBusiness


PermissionsList, View, Delete Affiliate Entity Group







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the affiliate entity group.


 
 Example:  18
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
    }
}
Query affiliate entity groups
post/services/core/query
Use the query service to find affiliate entity groups that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples