PUT api/clients/{id}

Attention! This route is deprecated, use '/client/{id}'.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the client.

integer

Required

Body Parameters

The ClientViewModel, containing information about the client.

FiscaalGemak.Web.Api.Models.Models.ClientViewModel
NameDescriptionTypeAdditional information
Addresses

Collection of FiscaalGemak.Web.Api.Models.Models.AddressViewModel

None.

BeconNumber

integer

None.

BirthDate

date

None.

ChamberOfCommerceNumber

string

String length: inclusive between 0 and 50

Classification

FiscaalGemak.Core.Models.Enums.Classification

None.

ClientGroupIsVip

boolean

None.

ClientGroupName

string

String length: inclusive between 0 and 128

ContactPerson

FiscaalGemak.Web.Api.Models.Models.ContactPersonViewModel

None.

DateEndCustomerRelation

date

None.

DateStartCustomerRelation

date

None.

DeceasedDate

date

None.

DefaultAssignedToUser

string

String length: inclusive between 0 and 128

FiscalDefaultAssignedToUser

string

String length: inclusive between 0 and 128

FinancialDefaultAssignedToUser

string

String length: inclusive between 0 and 128

AdministrativeDefaultAssignedToUser

string

String length: inclusive between 0 and 128

EmailAddresses

Collection of string

None.

ExternalVatNumber

string

String length: inclusive between 0 and 50

Id

integer

None.

IdentificationNumber

string

String length: inclusive between 0 and 9

Initials

string

String length: inclusive between 0 and 20

Name

string

String length: inclusive between 0 and 255

FirstName

string

String length: inclusive between 0 and 80

Number

string

String length: inclusive between 0 and 10

PhoneNumbers

Collection of string

None.

PostTitle

string

String length: inclusive between 0 and 128

PostTitleCustom

string

String length: inclusive between 0 and 50

Prefix

string

String length: inclusive between 0 and 50

PreTitle

string

String length: inclusive between 0 and 128

PreTitleCustom

string

String length: inclusive between 0 and 50

ReportSigner

string

String length: inclusive between 0 and 128

ResponsibleUser

string

String length: inclusive between 0 and 128

Salutation

FiscaalGemak.Core.Models.Enums.Salutation

None.

SalutationCustom

string

String length: inclusive between 0 and 50

SbiCode

string

String length: inclusive between 2 and 5

SecondReportSigner

string

String length: inclusive between 0 and 128

Surname

string

String length: inclusive between 0 and 128

TaxConsultant

string

String length: inclusive between 0 and 128

Type

FiscaalGemak.Core.Models.ClientType

None.

TypeOfBusinessEntity

FiscaalGemak.Core.Models.BusinessForm

None.

VatNumber

string

String length: inclusive between 0 and 50

Services

Collection of FiscaalGemak.Web.Models.ViewModels.ServiceViewModel

None.

Request Formats

application/json, text/json

Sample:
{
  "Addresses": [
    {
      "City": "sample string 1",
      "Country": "sample string 2",
      "Postcode": "sample string 3",
      "Street": "sample string 4",
      "StreetNumber": "sample string 5",
      "StreetNumberAddition": "sample string 6",
      "Type": 0
    },
    {
      "City": "sample string 1",
      "Country": "sample string 2",
      "Postcode": "sample string 3",
      "Street": "sample string 4",
      "StreetNumber": "sample string 5",
      "StreetNumberAddition": "sample string 6",
      "Type": 0
    }
  ],
  "BeconNumber": 1,
  "BirthDate": "2023-12-01T07:49:04.3617351+01:00",
  "ChamberOfCommerceNumber": "sample string 1",
  "Classification": 0,
  "ClientGroupIsVip": true,
  "ClientGroupName": "sample string 3",
  "ContactPerson": {
    "Id": 1,
    "Email": "sample string 1",
    "Initials": "sample string 2",
    "FirstName": "sample string 3",
    "Prefix": "sample string 4",
    "Surname": "sample string 5",
    "TelephoneNumber": "sample string 6",
    "SalutationCustom": "sample string 7",
    "Salutation": 0,
    "AuthenticationType": 0
  },
  "DateEndCustomerRelation": "2023-12-01T07:49:04.3617351+01:00",
  "DateStartCustomerRelation": "2023-12-01T07:49:04.3617351+01:00",
  "DeceasedDate": "2023-12-01T07:49:04.3617351+01:00",
  "DefaultAssignedToUser": "sample string 4",
  "FiscalDefaultAssignedToUser": "sample string 5",
  "FinancialDefaultAssignedToUser": "sample string 6",
  "AdministrativeDefaultAssignedToUser": "sample string 7",
  "EmailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "ExternalVatNumber": "sample string 8",
  "Id": 1,
  "IdentificationNumber": "sample string 9",
  "Initials": "sample string 10",
  "Name": "sample string 11",
  "FirstName": "sample string 12",
  "Number": "sample string 13",
  "PhoneNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "PostTitle": "sample string 14",
  "PostTitleCustom": "sample string 15",
  "Prefix": "sample string 16",
  "PreTitle": "sample string 17",
  "PreTitleCustom": "sample string 18",
  "ReportSigner": "sample string 19",
  "ResponsibleUser": "sample string 20",
  "Salutation": 0,
  "SalutationCustom": "sample string 21",
  "SbiCode": "sample string 22",
  "SecondReportSigner": "sample string 23",
  "Surname": "sample string 24",
  "TaxConsultant": "sample string 25",
  "Type": 0,
  "TypeOfBusinessEntity": 0,
  "VatNumber": "sample string 26",
  "Services": [
    {
      "ClientType": 0,
      "DeclarationType": 0,
      "Id": 1,
      "ServiceType": 1
    },
    {
      "ClientType": 0,
      "DeclarationType": 0,
      "Id": 1,
      "ServiceType": 1
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated ClientViewModel, containing information about the client.

FiscaalGemak.Web.Api.Models.Models.ClientViewModel
NameDescriptionTypeAdditional information
Addresses

Collection of FiscaalGemak.Web.Api.Models.Models.AddressViewModel

None.

BeconNumber

integer

None.

BirthDate

date

None.

ChamberOfCommerceNumber

string

String length: inclusive between 0 and 50

Classification

FiscaalGemak.Core.Models.Enums.Classification

None.

ClientGroupIsVip

boolean

None.

ClientGroupName

string

String length: inclusive between 0 and 128

ContactPerson

FiscaalGemak.Web.Api.Models.Models.ContactPersonViewModel

None.

DateEndCustomerRelation

date

None.

DateStartCustomerRelation

date

None.

DeceasedDate

date

None.

DefaultAssignedToUser

string

String length: inclusive between 0 and 128

FiscalDefaultAssignedToUser

string

String length: inclusive between 0 and 128

FinancialDefaultAssignedToUser

string

String length: inclusive between 0 and 128

AdministrativeDefaultAssignedToUser

string

String length: inclusive between 0 and 128

EmailAddresses

Collection of string

None.

ExternalVatNumber

string

String length: inclusive between 0 and 50

Id

integer

None.

IdentificationNumber

string

String length: inclusive between 0 and 9

Initials

string

String length: inclusive between 0 and 20

Name

string

String length: inclusive between 0 and 255

FirstName

string

String length: inclusive between 0 and 80

Number

string

String length: inclusive between 0 and 10

PhoneNumbers

Collection of string

None.

PostTitle

string

String length: inclusive between 0 and 128

PostTitleCustom

string

String length: inclusive between 0 and 50

Prefix

string

String length: inclusive between 0 and 50

PreTitle

string

String length: inclusive between 0 and 128

PreTitleCustom

string

String length: inclusive between 0 and 50

ReportSigner

string

String length: inclusive between 0 and 128

ResponsibleUser

string

String length: inclusive between 0 and 128

Salutation

FiscaalGemak.Core.Models.Enums.Salutation

None.

SalutationCustom

string

String length: inclusive between 0 and 50

SbiCode

string

String length: inclusive between 2 and 5

SecondReportSigner

string

String length: inclusive between 0 and 128

Surname

string

String length: inclusive between 0 and 128

TaxConsultant

string

String length: inclusive between 0 and 128

Type

FiscaalGemak.Core.Models.ClientType

None.

TypeOfBusinessEntity

FiscaalGemak.Core.Models.BusinessForm

None.

VatNumber

string

String length: inclusive between 0 and 50

Services

Collection of FiscaalGemak.Web.Models.ViewModels.ServiceViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Addresses": [
    {
      "City": "sample string 1",
      "Country": "sample string 2",
      "Postcode": "sample string 3",
      "Street": "sample string 4",
      "StreetNumber": "sample string 5",
      "StreetNumberAddition": "sample string 6",
      "Type": 0
    },
    {
      "City": "sample string 1",
      "Country": "sample string 2",
      "Postcode": "sample string 3",
      "Street": "sample string 4",
      "StreetNumber": "sample string 5",
      "StreetNumberAddition": "sample string 6",
      "Type": 0
    }
  ],
  "BeconNumber": 1,
  "BirthDate": "2023-12-01T07:49:04.3617351+01:00",
  "ChamberOfCommerceNumber": "sample string 1",
  "Classification": 0,
  "ClientGroupIsVip": true,
  "ClientGroupName": "sample string 3",
  "ContactPerson": {
    "Id": 1,
    "Email": "sample string 1",
    "Initials": "sample string 2",
    "FirstName": "sample string 3",
    "Prefix": "sample string 4",
    "Surname": "sample string 5",
    "TelephoneNumber": "sample string 6",
    "SalutationCustom": "sample string 7",
    "Salutation": 0,
    "AuthenticationType": 0
  },
  "DateEndCustomerRelation": "2023-12-01T07:49:04.3617351+01:00",
  "DateStartCustomerRelation": "2023-12-01T07:49:04.3617351+01:00",
  "DeceasedDate": "2023-12-01T07:49:04.3617351+01:00",
  "DefaultAssignedToUser": "sample string 4",
  "FiscalDefaultAssignedToUser": "sample string 5",
  "FinancialDefaultAssignedToUser": "sample string 6",
  "AdministrativeDefaultAssignedToUser": "sample string 7",
  "EmailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "ExternalVatNumber": "sample string 8",
  "Id": 1,
  "IdentificationNumber": "sample string 9",
  "Initials": "sample string 10",
  "Name": "sample string 11",
  "FirstName": "sample string 12",
  "Number": "sample string 13",
  "PhoneNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "PostTitle": "sample string 14",
  "PostTitleCustom": "sample string 15",
  "Prefix": "sample string 16",
  "PreTitle": "sample string 17",
  "PreTitleCustom": "sample string 18",
  "ReportSigner": "sample string 19",
  "ResponsibleUser": "sample string 20",
  "Salutation": 0,
  "SalutationCustom": "sample string 21",
  "SbiCode": "sample string 22",
  "SecondReportSigner": "sample string 23",
  "Surname": "sample string 24",
  "TaxConsultant": "sample string 25",
  "Type": 0,
  "TypeOfBusinessEntity": 0,
  "VatNumber": "sample string 26",
  "Services": [
    {
      "ClientType": 0,
      "DeclarationType": 0,
      "Id": 1,
      "ServiceType": 1
    },
    {
      "ClientType": 0,
      "DeclarationType": 0,
      "Id": 1,
      "ServiceType": 1
    }
  ]
}