Represents the history of relatives (spr) in Business Central.
Methods
| Method |
Return Type |
Description |
| GET sprRelativesHistory |
sprRelativesHistory |
Gets a relative history object. |
| DELETE sprRelativesHistory |
none |
Deletes a relative history object. |
| POST sprRelativesHistory |
sprRelativesHistory |
Creates a relative history object. |
| PATCH sprRelativesHistory |
sprRelativesHistory |
Updates a relative history object. |
Navigation
| Navigation |
Return Type |
Description |
| sprRelatives |
sprRelative |
Gets the relative associated with the relative history. |
| sprEmployees |
sprEmployee |
Gets the employee associated with the relative history. |
Properties
| Property |
Type |
Description |
Relation to |
| id |
Guid |
Specifies the relatives's history ID. Non-editable. |
|
| employeeNumber |
String[20] |
Specifies the employee's number. |
sprEmployees.number |
| employeeId |
Guid |
Specifies the employee's ID. |
sprEmployees.id |
| relativeLineNo |
Int32 |
Specifies the relative's line number. |
sprRelatives.lineNo |
| relativeLineId |
Guid |
Specifies the relative's line ID. |
sprRelatives.id |
| validFromForAPI |
Date |
Specifies the relatives's history valid from date for API. |
|
| disabled |
Boolean |
Specifies if the relative history is disabled. |
|
| raisedByOneOfParents |
Boolean |
Specifies if the relative was raised by one of the parents. |
|
| lastModifiedDateTime |
DateTimeOffset |
Specifies the relative's history last modified date. Read-Only. |
|
Examples
Create sprRelativesHistory
POST URI: /companies({{companyId}})/sprRelativesHistory
Request
{
"employeeId": "{{employeeId}}",
"relativeLineId": "{{relativeLineId}}",
"validFromForAPI": "2025-01-16",
"disabled": false,
"raisedByOneOfParents": true
}