GET PlanCare2Api/Contracts?bsn={bsn}&referenceDate={referenceDate}

Fetches active contracts based on client identifier.

Request Information

URI Parameters

Name	Description	Type	Additional information
bsn	Social security number of client	string	Required
referenceDate	Date to validate on	date	Required

Body Parameters

None.

Response Information

Resource Description

List of contracts

Collection of Contract

Name	Description	Type	Additional information
Id	Id for the contract	integer	-
StartDate	Startdate of the contract	date	-
EndDate	Enddate of the contract	date	Nullable
ContractInfo	ContractInfo specification returns the contract id, description, contracttype code, contract start date and end date	string	-
ContractType	Contracttype specification.	ContractType	-
Debtor	The debtor.	Debtor	-
Supplier	The supplier.	Supplier	-
RelationCorrelationDebtorId	The relation correlation debtor identifier.	integer	Nullable
RelationCorrelationInvoiceReceiverId	The relation correlation invoice receiver identifier.	integer	Nullable

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "StartDate": "2026-05-26T21:09:02.6653647+02:00",
    "EndDate": "2026-05-26T21:09:02.6653647+02:00",
    "ContractInfo": "sample string 3",
    "ContractType": {
      "$id": "2",
      "Id": 1,
      "Code": "sample string 2",
      "Description": "sample string 3",
      "IsActive": true,
      "Source": "sample string 5"
    },
    "Debtor": {
      "$id": "3",
      "Description": "sample string 1",
      "StartDate": "2026-05-26T21:09:02.6653647+02:00",
      "EndDate": "2026-05-26T21:09:02.6653647+02:00",
      "NumberExtern": "sample string 2",
      "NumberIntern": "sample string 3"
    },
    "Supplier": {
      "$id": "4",
      "Code": "sample string 1",
      "Description": "sample string 2",
      "StartDate": "2026-05-26T21:09:02.6653647+02:00",
      "EndDate": "2026-05-26T21:09:02.6653647+02:00"
    },
    "RelationCorrelationDebtorId": 1,
    "RelationCorrelationInvoiceReceiverId": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <Contract>
    <ContractInfo>sample string 3</ContractInfo>
    <ContractType>
      <Code>sample string 2</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <Source>sample string 5</Source>
    </ContractType>
    <Debtor>
      <Description>sample string 1</Description>
      <EndDate>2026-05-26T21:09:02.6653647+02:00</EndDate>
      <NumberExtern>sample string 2</NumberExtern>
      <NumberIntern>sample string 3</NumberIntern>
      <StartDate>2026-05-26T21:09:02.6653647+02:00</StartDate>
    </Debtor>
    <EndDate>2026-05-26T21:09:02.6653647+02:00</EndDate>
    <Id>1</Id>
    <RelationCorrelationDebtorId>1</RelationCorrelationDebtorId>
    <RelationCorrelationInvoiceReceiverId>1</RelationCorrelationInvoiceReceiverId>
    <StartDate>2026-05-26T21:09:02.6653647+02:00</StartDate>
    <Supplier>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <EndDate>2026-05-26T21:09:02.6653647+02:00</EndDate>
      <StartDate>2026-05-26T21:09:02.6653647+02:00</StartDate>
    </Supplier>
  </Contract>
  <Contract>
    <ContractInfo>sample string 3</ContractInfo>
    <ContractType>
      <Code>sample string 2</Code>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <Source>sample string 5</Source>
    </ContractType>
    <Debtor>
      <Description>sample string 1</Description>
      <EndDate>2026-05-26T21:09:02.6653647+02:00</EndDate>
      <NumberExtern>sample string 2</NumberExtern>
      <NumberIntern>sample string 3</NumberIntern>
      <StartDate>2026-05-26T21:09:02.6653647+02:00</StartDate>
    </Debtor>
    <EndDate>2026-05-26T21:09:02.6653647+02:00</EndDate>
    <Id>1</Id>
    <RelationCorrelationDebtorId>1</RelationCorrelationDebtorId>
    <RelationCorrelationInvoiceReceiverId>1</RelationCorrelationInvoiceReceiverId>
    <StartDate>2026-05-26T21:09:02.6653647+02:00</StartDate>
    <Supplier>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <EndDate>2026-05-26T21:09:02.6653647+02:00</EndDate>
      <StartDate>2026-05-26T21:09:02.6653647+02:00</StartDate>
    </Supplier>
  </Contract>
</ArrayOfContract>