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.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

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"
sortOrder
string
 Default:  "ascending"
Select ascending or descending sort order for affiliate entities that match the memberFilter. Only applicable when the groupType is all.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
integer
Specifies the maximum number of affiliate entities that you can include in the group when using memberFilter. Only applicable when groupType is all.


 
 Example:  11
sortField
string
Select the affiliate entity group field by which you want to sort.


 
 Example:  "AFFILIATEENTITYID"
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
conditionType
string
 Default:  "and"
The condition type for filters defined to create the affiliate entity group.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string or null
Use this field to specify the expression, if conditionType is set to expression.


 
 Example:  "(1 AND 2)"
Array of objects or null
One or more filters used to specify the affiliate entities you want to include in the affiliate entity group.


 
 Array 
field
string
Affiliate entity field to filter on, such as ID or country code.


 
 Example:  "AFFILIATEENTITYID"
operator
string
 Default:  "isOneOf"
Comparison operator.


 Enum: "contains" "doesNotEqual" "equals" "isCurrentUser" "isEmpty" "isGreaterThan" "isLessThan" "isNotEmpty" "isNotOneOf" "isOneOf"  
 Example:  "isOneOf"
value
string
The value to compare against.


 
 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.


 
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": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "maxMatches": 0,
    • "sortField": "AFFILIATEENTITYID",
    • "conditionType": "and",
    • "expression": "",
    • "sortOrder": "ascending",
    • "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.


 
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"
sortOrder
string
 Default:  "ascending"
Select ascending or descending sort order for affiliate entities that match the memberFilter. Only applicable when the groupType is all.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
integer
Specifies the maximum number of affiliate entities that you can include in the group when using memberFilter. Only applicable when groupType is all.


 
 Example:  11
sortField
string
Select the affiliate entity group field by which you want to sort.


 
 Example:  "AFFILIATEENTITYID"
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
conditionType
string
 Default:  "and"
The condition type for filters defined to create the affiliate entity group.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string or null
Use this field to specify the expression, if conditionType is set to expression.


 
 Example:  "(1 AND 2)"
Array of objects or null
One or more filters used to specify the affiliate entities you want to include in the affiliate entity group.


 
 Array 
field
string
Affiliate entity field to filter on, such as ID or country code.


 
 Example:  "AFFILIATEENTITYID"
operator
string
 Default:  "isOneOf"
Comparison operator.


 Enum: "contains" "doesNotEqual" "equals" "isCurrentUser" "isEmpty" "isGreaterThan" "isLessThan" "isNotEmpty" "isNotOneOf" "isOneOf"  
 Example:  "isOneOf"
value
string
The value to compare against.


 
 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.


 
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
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "company-config/affiliate-entity-group"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
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 between (object) or not between (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.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


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"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}