GET client/deferral?year={year}&mustHaveDeferral={mustHaveDeferral}&mustHaveClientRelation={mustHaveClientRelation}

This feature is not available in all subscriptions. Contact your accountmanager for more information. This endpoint will return the deferral status (Dutch: “Uitstel”) for the requested year. For this request the year is mandatory. Optionally you can limit the returns to the customers with the service 'Uitstel' marked and / or the clients that have an active relation to your organization. This is based on either a populated end-date in the future or blank end-date.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
year

The year.

 integer

Required
mustHaveDeferral

If true, only clients that have the deferral service enabled are returned.

 boolean

Default value is False
mustHaveClientRelation

If true, only clients that have a client relation are returned.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The ClientDeferralModel, containing information about the deferrals.

Collection of FiscaalGemak.Web.Api.Models.Models.ClientDeferralViewModel
NameDescriptionTypeAdditional information
DeferralId

Gets or sets the id of the deferral.

 integer

None.
ClientId

Gets or sets the id If the client.

 integer

None.
BeconNumber

Gets or sets the Becon number.

 integer

None.
Bsn

Gets or sets the BSN of the client.

 string

None.
Rsin

Gets or sets the RSIN of the organisation.

 string

None.
Year

Gets or sets the year.

 integer

None.
PeriodStartDate

Gets or sets the start date of the period.

 string

None.
PeriodEndDate

Gets or sets the end date of the period.

 string

None.
DeferralStatus

Gets or sets the status of the deferral.

 string

None.
DeadlineDate

Gets or sets the date before which the declaration must be received.

 string

None.
ReceivedDate

Gets or sets the date when the declaration was received.

 string

None.
ReceivedDateSbu

Gets or sets the date when the SBU was received.

 string

None.
RejectReason

Gets or sets the reason of rejection.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "DeferralId": 1,
    "ClientId": 1,
    "BeconNumber": 1,
    "Bsn": "sample string 1",
    "Rsin": "sample string 2",
    "Year": 1,
    "PeriodStartDate": "sample string 3",
    "PeriodEndDate": "sample string 4",
    "DeferralStatus": "sample string 5",
    "DeadlineDate": "sample string 6",
    "ReceivedDate": "sample string 7",
    "ReceivedDateSbu": "sample string 8",
    "RejectReason": "sample string 9"
  },
  {
    "DeferralId": 1,
    "ClientId": 1,
    "BeconNumber": 1,
    "Bsn": "sample string 1",
    "Rsin": "sample string 2",
    "Year": 1,
    "PeriodStartDate": "sample string 3",
    "PeriodEndDate": "sample string 4",
    "DeferralStatus": "sample string 5",
    "DeadlineDate": "sample string 6",
    "ReceivedDate": "sample string 7",
    "ReceivedDateSbu": "sample string 8",
    "RejectReason": "sample string 9"
  }
]