Attribute Relations

The Attribute Relations API in Unit4 ERPx manages attribute relation data - creation, retrieval, updates, and deletion of attribute relationship records. It is designed for integration with mobile and other external applications, supporting microservice-based development, testing, and maintenance.

Purpose:
The Attribute Relations API manages all aspects of attribute relationship data, including creation, update, validation, and deletion. Attribute relations define how different attributes in ERPx are connected to each other, enabling complex master data hierarchies and dependencies between business entities.

Base URL:
/v1/attribute-relations

Authentication:
All APIs require a Client ID and Client Secret.
Refer to the global authentication documentation for details.

System Parameters:
System parameters for attribute configuration are available in Online Help → Administration → Attributes → Fixed Registers → System Parameters.    

Supported Methods

Swagger / Schema

Version v1

Method Details

• POST Method
• GET Method (Single)
• GET Method (Objects)
• PATCH Method
• DELETE Method

{
  "attributeId": "C1",
  "attributeValue": "100",
  "relatedAttributeId": "C0",
  "relationValue": "907",
  "companyId": "EN",
  "dateFrom": "1900-01-01T00:00:00.000Z",
  "dateTo": "2099-12-31T00:00:00.000Z",
  "percentage": 100
}

GET /v1/attribute-relations/C1/100/C0/907?companyId=EN

{
  "attributeId": "C1",
  "attributeName": "Cost Center",
  "attributeValue": "100",
  "relatedAttributeId": "C0",
  "relatedAttributeName": "Department",
  "relationValue": "907",
  "companyId": "EN",
  "dateFrom": "1900-01-01T00:00:00.000Z",
  "dateTo": "2099-12-31T00:00:00.000Z",
  "percentage": 100
}

{
GET /v1/objects/attribute-relations?filter=attributeId%20eq%20%27C1%27&limit=10
}

{
GET /v1/objects/attribute-relations?filter=attributeId%20eq%20%27C1%27%20and%20relatedAttributeId%20eq%20%27C0%27&limit=10
}

[
  {
    "attributeId": "C1",
    "attributeName": "Cost Center",
    "attributeValue": "100",
    "attributeValueFrom": 0,
    "attributeValueTo": 209999,
    "relatedAttributeId": "C0",
    "relatedAttributeName": "Department",
    "relationValue": "907",
    "companyId": "EN",
    "dateFrom": "1900-01-01T00:00:00.000Z",
    "dateTo": "2099-12-31T00:00:00.000Z",
    "percentage": 100
  },
  {
    "attributeId": "C1",
    "attributeName": "Cost Center",
    "attributeValue": "120",
    "attributeValueFrom": 0,
    "attributeValueTo": 209999,
    "relatedAttributeId": "C0",
    "relatedAttributeName": "Department",
    "relationValue": "908",
    "companyId": "EN",
    "dateFrom": "1900-01-01T00:00:00.000Z",
    "dateTo": "2099-12-31T00:00:00.000Z",
    "percentage": 100
  }
]

[
    {
  "path": "/percentage",
  "op": "replace",
  "value": 50
    }
]

[
    {
  "path": "/dateTo",
  "op": "replace",
  "value": "2025-12-31T00:00:00.000Z"
    }
]

[
    {
  "path": "/relationValue",
  "op": "replace",
  "value": "908"
    }
]

DELETE /v1/attribute-relations/C1/100/C0/907?companyId=EN

Best Practices

• Verify attribute relations exist in the ERPx configuration before attempting to create attribute relations via API.
• Validate both attribute IDs and their values before creating relations - both the source and target attributes must exist.
• Check for existing relations before creating new ones to avoid duplicate errors.
• Cannot update key fields - attributeValue is a key field and cannot be modified via PATCH. Delete and recreate the relation if key values need to change.
• Understand deletion is permanent - DELETE permanently removes the relation (not a soft delete like some other APIs).
• Use the Objects endpoint (/v1/objects/attribute-relations) for bulk queries and filtering with OData syntax.
• Leverage OData filters to efficiently retrieve specific relations without fetching all data.
• Test limit and offset parameters to optimize performance when working with large datasets.
• Use Swagger UI for testing and schema validation before production calls.
• Handle error codes gracefully - implement retry/backoff logic according to global rate limits.
• Always check for deprecation alerts on this endpoint version.
• Validate attribute relation before sending DELETE requests to avoid unintentional data loss.

Related endpoints

Action APIs