POST client/{id}/relations

Add a new relation to a client.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the client.

integer

Required

Body Parameters

The RelationViewModel, containing information about the relation.

FiscaalGemak.Web.Api.Models.Models.RelationViewModel
NameDescriptionTypeAdditional information
IdentificationNumber

Gets the identification number of the relation.

string

None.

RelationClientId

Gets or sets the client id of the relation.

integer

Required

StartDate

Gets or sets the start date of the relation.

date

Required

EndDate

Gets or sets the end date of the relation. Defaults to no end date.

date

None.

InterestPercentile

Gets or sets the interest percentile of the relation.

decimal number

Required

Range: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:
{
  "IdentificationNumber": "sample string 1",
  "RelationClientId": 2,
  "StartDate": "2025-10-26T15:39:04.9744558+01:00",
  "EndDate": "2025-10-26T15:39:04.9744558+01:00",
  "InterestPercentile": 4.0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns status code 201-Created with the API route to get the client relation details, upon successful creation of the client relation.

FiscaalGemak.Web.Api.Models.Models.RelationViewModel
NameDescriptionTypeAdditional information
IdentificationNumber

Gets the identification number of the relation.

string

None.

RelationClientId

Gets or sets the client id of the relation.

integer

Required

StartDate

Gets or sets the start date of the relation.

date

Required

EndDate

Gets or sets the end date of the relation. Defaults to no end date.

date

None.

InterestPercentile

Gets or sets the interest percentile of the relation.

decimal number

Required

Range: inclusive between 0 and 100

Response Formats

application/json, text/json

Sample:
{
  "IdentificationNumber": "sample string 1",
  "RelationClientId": 2,
  "StartDate": "2025-10-26T15:39:04.9744558+01:00",
  "EndDate": "2025-10-26T15:39:04.9744558+01:00",
  "InterestPercentile": 4.0
}