POST declaration

Add a new declaration to Fiscaal Gemak.

Request Information

URI Parameters

None.

Body Parameters

The DeclarationCreateViewModel, containing information about the declaration.

FiscaalGemak.Web.Api.Models.Models.DeclarationCreateViewModel
NameDescriptionTypeAdditional information
ClientId

Gets or sets the Id of the client. This parameter is optional. If the Id of the client is provided, the declaration will be linked to this client. If the parameter is not provided, the declaration will be linked to a client based on the identificationnumber in the xbrl file.

integer

None.

Deliver

Gets or sets a value indicating whether the declaration should be dispatched to the tax authorities immediately. This parameter is optional. If the parameter is not provided, the declaration only gets added to Fiscaal Gemak.

boolean

None.

Files

Gets or sets the declaration to be send to FiscaalGemak. Only one file can be added. A base 64 string of an Xbrl declaration file is expected here.

Collection of string

Required

Request Formats

application/json, text/json

Sample:
{
  "ClientId": 1,
  "Deliver": true,
  "Files": [
    "sample string 1",
    "sample string 2"
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The DeclarationResponseModel, containing information about the declaration.

FiscaalGemak.Core.Models.Models.DeclarationResponseModel
NameDescriptionTypeAdditional information
ResponseCode

FiscaalGemak.Core.Models.Enums.DeclarationResponseCode

None.

ResponseMessage

string

None.

DeclarationId

integer

None.

Response Formats

application/json, text/json

Sample:

Sample not available.