GET client/{id}/declarations?declarationType={declarationType}&periodStart={periodStart}&periodEnd={periodEnd}

Get declaration(s) from Fiscaal Gemak by client.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the client.

integer

Required

declarationType

The declarationType of the declaration.

FiscaalGemak.Web.Api.Models.Enums.DeclarationType

None.

periodStart

The startdate in which the declaration must fall.

date

None.

periodEnd

The end date in which the declaration must fall.

date

None.

Body Parameters

None.

Response Information

Resource Description

The DeclarationViewModel, containing information about the declaration.

Collection of FiscaalGemak.Web.Api.Models.Models.DeclarationViewModel
NameDescriptionTypeAdditional information
ClientId

integer

None.

ClientName

string

None.

CurrentStepName

string

None.

DeclarationId

integer

None.

DeclarationType

FiscaalGemak.Web.Api.Models.Enums.DeclarationType

None.

InternalStatus

FiscaalGemak.Web.Api.Models.Enums.InternalStatus

None.

PeriodEnd

date

None.

PeriodStart

date

None.

Year

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ClientId": 1,
    "ClientName": "sample string 2",
    "CurrentStepName": "sample string 3",
    "DeclarationId": 4,
    "DeclarationType": 1,
    "InternalStatus": 1,
    "PeriodEnd": "2022-12-03T14:24:59.6622394+01:00",
    "PeriodStart": "2022-12-03T14:24:59.6622394+01:00",
    "Year": 7
  },
  {
    "ClientId": 1,
    "ClientName": "sample string 2",
    "CurrentStepName": "sample string 3",
    "DeclarationId": 4,
    "DeclarationType": 1,
    "InternalStatus": 1,
    "PeriodEnd": "2022-12-03T14:24:59.6622394+01:00",
    "PeriodStart": "2022-12-03T14:24:59.6622394+01:00",
    "Year": 7
  }
]

application/xml, text/xml

Sample:
<ArrayOfDeclarationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FiscaalGemak.Web.Api.Models.Models">
  <DeclarationViewModel>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <CurrentStepName>sample string 3</CurrentStepName>
    <DeclarationId>4</DeclarationId>
    <DeclarationType>IncomeTax</DeclarationType>
    <InternalStatus>Created</InternalStatus>
    <PeriodEnd>2022-12-03T14:24:59.6622394+01:00</PeriodEnd>
    <PeriodStart>2022-12-03T14:24:59.6622394+01:00</PeriodStart>
    <Year>7</Year>
  </DeclarationViewModel>
  <DeclarationViewModel>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <CurrentStepName>sample string 3</CurrentStepName>
    <DeclarationId>4</DeclarationId>
    <DeclarationType>IncomeTax</DeclarationType>
    <InternalStatus>Created</InternalStatus>
    <PeriodEnd>2022-12-03T14:24:59.6622394+01:00</PeriodEnd>
    <PeriodStart>2022-12-03T14:24:59.6622394+01:00</PeriodStart>
    <Year>7</Year>
  </DeclarationViewModel>
</ArrayOfDeclarationViewModel>