Master Data Sync Setting

Master Data Sync Setting - Get

HTTP Request

GET /api/v1/master-data-sync-setting/{id}

Interactive Demo

📋 Description: Retrieves the synchronization settings for a specific financial entity within the organization’s structure, identified by the provided ID. This operation ensures accurate alignment of master data across the financial hierarchy.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseMasterDataSyncSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "targetServerId": 0,
    "targetServerDisplayId": "string",
    "status": "CREATED",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "syncEntity": "EXCHANGE_RATE",
    "sourceSyncMode": "EXCEL",
    "sourceSyncServerId": 0,
    "sourceSyncServerDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Update

HTTP Request

PUT /api/v1/master-data-sync-setting/{id}

Interactive Demo

📋 Description: Updates the master data synchronization settings for a specified financial entity within the organizational structure, allowing for adjustments to the hierarchy and data management parameters.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	MasterDataSyncSettingDto	true	Request body containing the updated master data synchronization settings for the specified financial organization structure, including parameters that define the hierarchy and relationships of financial entities.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "targetServerId": 0,
  "targetServerDisplayId": "string",
  "status": "CREATED",
  "type": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "syncEntity": "EXCHANGE_RATE",
  "sourceSyncMode": "EXCEL",
  "sourceSyncServerId": 0,
  "sourceSyncServerDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseMasterDataSyncSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "targetServerId": 0,
    "targetServerDisplayId": "string",
    "status": "CREATED",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "syncEntity": "EXCHANGE_RATE",
    "sourceSyncMode": "EXCEL",
    "sourceSyncServerId": 0,
    "sourceSyncServerDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Delete

HTTP Request

DELETE /api/v1/master-data-sync-setting/{id}

Interactive Demo

📋 Description: Deletes a specified master data synchronization setting identified by the unique ID, ensuring the integrity of the financial organization structure and hierarchy within the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Create Or Update Bulk

HTTP Request

PUT /api/v1/master-data-sync-setting/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple financial organization structure settings in bulk, ensuring alignment with the latest hierarchy and organizational requirements for financial entities. This operation facilitates efficient management of master data synchronization within the financial domain.

Parameters

Name	In	Type	Required	Description
body	body	MasterDataSyncSettingDto	true	Request body containing bulk data for creating or updating financial organization structure settings, including hierarchical relationships and entity attributes.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "targetServerId": 0,
    "targetServerDisplayId": "string",
    "status": "CREATED",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "syncEntity": "EXCHANGE_RATE",
    "sourceSyncMode": "EXCEL",
    "sourceSyncServerId": 0,
    "sourceSyncServerDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListMasterDataSyncSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "targetServerId": 0,
      "targetServerDisplayId": "string",
      "status": "CREATED",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "syncEntity": "EXCHANGE_RATE",
      "sourceSyncMode": "EXCEL",
      "sourceSyncServerId": 0,
      "sourceSyncServerDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Create Or Update

HTTP Request

PUT /api/v1/master-data-sync-setting/createOrUpdate

Interactive Demo

📋 Description: Creates or updates master data synchronization settings for financial organizations, ensuring accurate representation of organizational structure and hierarchy within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	MasterDataSyncSettingDto	true	Request body containing the financial organization structure settings, including details for creating or updating the hierarchy and attributes of financial entities.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "targetServerId": 0,
  "targetServerDisplayId": "string",
  "status": "CREATED",
  "type": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "syncEntity": "EXCHANGE_RATE",
  "sourceSyncMode": "EXCEL",
  "sourceSyncServerId": 0,
  "sourceSyncServerDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseMasterDataSyncSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "targetServerId": 0,
    "targetServerDisplayId": "string",
    "status": "CREATED",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "syncEntity": "EXCHANGE_RATE",
    "sourceSyncMode": "EXCEL",
    "sourceSyncServerId": 0,
    "sourceSyncServerDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Bulk Update

HTTP Request

PUT /api/v1/master-data-sync-setting/bulk

Interactive Demo

📋 Description: Updates multiple master data synchronization settings for financial entities within the organization structure, ensuring alignment with the established hierarchy and operational requirements.

Parameters

Name	In	Type	Required	Description
body	body	MasterDataSyncSettingDto	true	Request body containing bulk synchronization settings for financial organization structures, including hierarchical relationships and entity configurations.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "targetServerId": 0,
    "targetServerDisplayId": "string",
    "status": "CREATED",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "syncEntity": "EXCHANGE_RATE",
    "sourceSyncMode": "EXCEL",
    "sourceSyncServerId": 0,
    "sourceSyncServerDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListMasterDataSyncSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "targetServerId": 0,
      "targetServerDisplayId": "string",
      "status": "CREATED",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "syncEntity": "EXCHANGE_RATE",
      "sourceSyncMode": "EXCEL",
      "sourceSyncServerId": 0,
      "sourceSyncServerDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Bulk Create

HTTP Request

POST /api/v1/master-data-sync-setting/bulk

Interactive Demo

📋 Description: Facilitates the bulk synchronization of master data settings for financial organization structures, enabling efficient updates to organizational hierarchies and entities.

Parameters

Name	In	Type	Required	Description
body	body	MasterDataSyncSettingDto	true	Request body containing bulk synchronization settings for financial organization structures, including hierarchical relationships and entity configurations.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "targetServerId": 0,
    "targetServerDisplayId": "string",
    "status": "CREATED",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "syncEntity": "EXCHANGE_RATE",
    "sourceSyncMode": "EXCEL",
    "sourceSyncServerId": 0,
    "sourceSyncServerDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListMasterDataSyncSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "targetServerId": 0,
      "targetServerDisplayId": "string",
      "status": "CREATED",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "syncEntity": "EXCHANGE_RATE",
      "sourceSyncMode": "EXCEL",
      "sourceSyncServerId": 0,
      "sourceSyncServerDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Bulk Delete

HTTP Request

DELETE /api/v1/master-data-sync-setting/bulk

Interactive Demo

📋 Description: Deletes multiple master data synchronization settings for financial entities, enabling the streamlined management of organizational structures and hierarchies within the financial organization.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers for bulk deletion of organization structure synchronization settings.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Search

HTTP Request

POST /api/v1/master-data-sync-setting/search

Interactive Demo

📋 Description: Submits a request to search for master data synchronization settings within the financial organization structure, enabling users to efficiently manage and align organizational hierarchies and entities.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	MasterDataSyncSettingDtoFilter	false	Request body containing the parameters for searching financial organization structure settings, including hierarchy details and entity specifications.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "targetServerIdEqual": 0,
  "targetServerDisplayIdLike": "string",
  "statusEqual": "CREATED",
  "typeEqual": "NAKISA",
  "sapVersionEqual": "ECC_EHP5",
  "syncEntityEqual": "EXCHANGE_RATE",
  "sourceSyncModeEqual": "EXCEL",
  "sourceSyncServerIdEqual": 0,
  "sourceSyncServerDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageMasterDataSyncSettingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "targetServerId": 0,
      "targetServerDisplayId": "string",
      "status": "CREATED",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "syncEntity": "EXCHANGE_RATE",
      "sourceSyncMode": "EXCEL",
      "sourceSyncServerId": 0,
      "sourceSyncServerDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Find All

HTTP Request

GET /api/v1/master-data-sync-setting

Interactive Demo

📋 Description: Retrieves the master data synchronization settings for the financial organization structure, providing essential configuration details related to the organization, hierarchy, and financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the financial organization structure synchronization settings should be returned in a paginated format, facilitating efficient data retrieval and management.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageMasterDataSyncSettingDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "targetServerId": 0,
      "targetServerDisplayId": "string",
      "status": "CREATED",
      "type": "NAKISA",
      "sapVersion": "ECC_EHP5",
      "syncEntity": "EXCHANGE_RATE",
      "sourceSyncMode": "EXCEL",
      "sourceSyncServerId": 0,
      "sourceSyncServerDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Master Data Sync Setting - Create

HTTP Request

POST /api/v1/master-data-sync-setting

Interactive Demo

📋 Description: Creates or updates synchronization settings for the financial organization structure, enabling efficient management of organizational hierarchy and financial entity data.

Parameters

Name	In	Type	Required	Description
body	body	MasterDataSyncSettingDto	true	Request body containing the financial organization structure settings, including details on hierarchy and entity relationships for effective master data synchronization.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "targetServerId": 0,
  "targetServerDisplayId": "string",
  "status": "CREATED",
  "type": "NAKISA",
  "sapVersion": "ECC_EHP5",
  "syncEntity": "EXCHANGE_RATE",
  "sourceSyncMode": "EXCEL",
  "sourceSyncServerId": 0,
  "sourceSyncServerDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseMasterDataSyncSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "targetServerId": 0,
    "targetServerDisplayId": "string",
    "status": "CREATED",
    "type": "NAKISA",
    "sapVersion": "ECC_EHP5",
    "syncEntity": "EXCHANGE_RATE",
    "sourceSyncMode": "EXCEL",
    "sourceSyncServerId": 0,
    "sourceSyncServerDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---