GET client?bsn={bsn}&rsin={rsin}&coc={coc}&offset={offset}&amount={amount}&modificationDateFrom={modificationDateFrom}&modificationDateTo={modificationDateTo}

Get a client from Fiscaal Gemak by bsn, rsin, coc or get all clients.

Request Information

URI Parameters

Name	Description	Type	Additional information
bsn	The bsn of the client.	string	None.
rsin	The rsin of the client.	string	None.
coc	The chamber of commerce number of the client.	string	None.
offset	When not filtering, the index on where to start returning client.	integer	None.
amount	When not filtering, how many clients to return.	integer	None.
modificationDateFrom	When not filtering, all clients modified on or after the specified date	date	None.
modificationDateTo	When not filtering, all clients modified before the specified date	date	None.

Body Parameters

None.

Response Information

Resource Description

A list of ClientViewModels, containing information about the client(s).

Collection of FiscaalGemak.Web.Api.Models.Models.ClientViewModel

Name	Description	Type	Additional information
Addresses	Gets or sets the addresses of the client.	Collection of FiscaalGemak.Web.Api.Models.Models.AddressViewModel	None.
BeconNumber	Gets or sets the becon number of the client.	integer	None.
BirthDate	Gets or sets the birth date of the client.	date	None.
ChamberOfCommerceNumber	Gets or sets the chamber of commerce number of the client.	string	String length: inclusive between 0 and 50
Classification	Gets or sets the classification of the client.	FiscaalGemak.Core.Models.Enums.Classification	None.
ClientGroupIsVip	Gets or sets a value indicating whether the client group a VIP group of the client.	boolean	None.
ClientGroupName	Gets or sets the client group name of the client.	string	String length: inclusive between 0 and 128
ContactPerson	Gets or sets the contact person of the client.	FiscaalGemak.Web.Api.Models.Models.ContactPersonViewModel	None.
DateEndCustomerRelation	Gets or sets the end date of the customer relation of the client.	date	None.
DateStartCustomerRelation	Gets or sets the start date of the customer relation of the client.	date	None.
DeceasedDate	Gets or sets the deceased date of the client.	date	None.
DefaultAssignedToUser	Gets or sets the default assigned to user of the client.	string	String length: inclusive between 0 and 128
FiscalDefaultAssignedToUser	Gets or sets the fiscal default assigned to user of the client.	string	String length: inclusive between 0 and 128
FinancialDefaultAssignedToUser	Gets or sets the financial default assigned to user of the client.	string	String length: inclusive between 0 and 128
AdministrativeDefaultAssignedToUser	Gets or sets the administrative default assigned to user of the client.	string	String length: inclusive between 0 and 128
EmailAddresses	Gets or sets the email addresses of the client.	Collection of string	None.
ExternalVatNumber	Gets or sets the External VAT number of the client.	string	String length: inclusive between 0 and 50
Id	Gets or sets the Id of the client.	integer	None.
IdentificationNumber	Gets or sets the identification number of the client.	string	String length: inclusive between 0 and 9
Initials	Gets or sets the initials of the client.	string	String length: inclusive between 0 and 20
Name	Gets or sets the full name of the client.	string	String length: inclusive between 0 and 255
FirstName	Gets or sets the firstname of the client.	string	String length: inclusive between 0 and 80
Number	Gets or sets the number of the client.	string	String length: inclusive between 0 and 10
PhoneNumbers	Gets or sets the phone numbers of the client.	Collection of string	None.
PostTitle	Gets or sets the post title of the client.	string	String length: inclusive between 0 and 128
PostTitleCustom	Gets or sets the custom post title of the client.	string	String length: inclusive between 0 and 50
Prefix	Gets or sets the prefix of the client.	string	String length: inclusive between 0 and 50
PreTitle	Gets or sets the pre title of the client.	string	String length: inclusive between 0 and 128
PreTitleCustom	Gets or sets the custom pre title of the client.	string	String length: inclusive between 0 and 50
ReportSigner	Gets or sets the report signer of the client.	string	String length: inclusive between 0 and 128
ResponsibleUser	Gets or sets the responsible user of the client.	string	String length: inclusive between 0 and 128
Salutation	Gets or sets the salutation of the client.	FiscaalGemak.Core.Models.Enums.Salutation	None.
SalutationCustom	Gets or sets the custom salutation of the client.	string	String length: inclusive between 0 and 50
SbiCode	Gets or sets the sbi code of the client.	string	String length: inclusive between 2 and 5
SecondReportSigner	Gets or sets the second report signer of the client.	string	String length: inclusive between 0 and 128
Surname	Gets or sets the surname of the client.	string	String length: inclusive between 0 and 128
TaxConsultant	Gets or sets the tax consultant of the client.	string	String length: inclusive between 0 and 128
Type	Gets or sets the client type of the client.	FiscaalGemak.Core.Models.ClientType	None.
TypeOfBusinessEntity	Gets or sets the type of business entity of the client.	FiscaalGemak.Core.Models.BusinessForm	None.
VatNumber	Gets or sets the VAT number of the client.	string	String length: inclusive between 0 and 50
Services	Gets or sets the Services of the client.	Collection of FiscaalGemak.Web.Models.ViewModels.ServiceViewModel	None.
CreationDate	Gets the creation date.	date	None.
ModificationDate	Gets the modification date.	date	None.
ApiModificationDate	Gets the modification date initiated from the API external source.	date	None.
ApiSourceName	Gets or sets the name from the API external source.	string	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": "2024-11-23T04:37:09.843796+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,
      "ApiModificationDate": "2024-11-23T04:37:09.843796+01:00",
      "ApiSourceName": "sample string 8"
    },
    "DateEndCustomerRelation": "2024-11-23T04:37:09.843796+01:00",
    "DateStartCustomerRelation": "2024-11-23T04:37:09.843796+01:00",
    "DeceasedDate": "2024-11-23T04:37:09.843796+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
      }
    ],
    "CreationDate": "2024-11-23T04:37:09.843796+01:00",
    "ModificationDate": "2024-11-23T04:37:09.843796+01:00",
    "ApiModificationDate": "2024-11-23T04:37:09.843796+01:00",
    "ApiSourceName": "sample string 29"
  },
  {
    "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": "2024-11-23T04:37:09.843796+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,
      "ApiModificationDate": "2024-11-23T04:37:09.843796+01:00",
      "ApiSourceName": "sample string 8"
    },
    "DateEndCustomerRelation": "2024-11-23T04:37:09.843796+01:00",
    "DateStartCustomerRelation": "2024-11-23T04:37:09.843796+01:00",
    "DeceasedDate": "2024-11-23T04:37:09.843796+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
      }
    ],
    "CreationDate": "2024-11-23T04:37:09.843796+01:00",
    "ModificationDate": "2024-11-23T04:37:09.843796+01:00",
    "ApiModificationDate": "2024-11-23T04:37:09.843796+01:00",
    "ApiSourceName": "sample string 29"
  }
]