Affiliate entities

Affiliate entities are associated entities defined within your Sage Intacct company. Use an affiliate entity to tag the related entity in a transaction. Tagging affiliate entities in transactions enables more detailed reporting. Affiliate entity is a standard dimension based on the list of entities in your Sage Intacct company. Because it's based on the entities in your company, the affiliate entity dimension is read-only.

List affiliate entities

get/objects/company-config/affiliate-entity

Returns a collection with a key, ID, and link for each affiliate entity. 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 Entities
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/affiliate-entity/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/company-config/affiliate-entity/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/company-config/affiliate-entity/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an affiliate entity
get/objects/company-config/affiliate-entity/{key}
Returns detailed information for a specified affiliate entity.



Permissions and other requirements



SubscriptionCompany


User typeBusiness


PermissionsList, View Affiliate Entities







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


 
 Example:  38
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "name": "United States of America",
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2016-06-27T00:00:00Z",
      • "modifiedDateTime": "2024-06-14T00:00:00Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/company-config/affiliate-entity/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query affiliate entities
post/services/core/query
Use the query service to find affiliate entities that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples