POST financial-numbers-document

Add a new financial numbers document to Fiscaal Gemak.

Request Information

URI Parameters

None.

Body Parameters

The FinancialNumbersDocumentViewModel, containing information about the financial numbers document.

FiscaalGemak.Web.Api.Models.Models.FinancialNumbersDocumentViewModel

Name	Description	Type	Additional information
ClientId	Gets or sets the Id of the client. This parameter is optional. If the Id of the client is provided, the financial numbers document will be linked to this client. If the parameter is not provided, the Rsin or VatNumber parameter should be provided.	integer	None.
Files	Gets or sets the financialnumbers document to be send to FiscaalGemak. Only one file can be added. A base 64 string of an RGS or GIS file is expected here.	Collection of string	Required
ImportFileType	Gets or sets the import file type (0 = RGS, 1 = GIS).	FiscaalGemak.Core.Models.Enums.FinancialNumbersDocumentImportFileType	None.
PeriodEnd	Gets or sets the period end of the financial numbers document.	date	None.
PeriodStart	Gets or sets the period start of the financial numbers document.	date	None.
RgsVersion	Gets or sets the rgs version. If the parameter is not provided and the importfiletype has been set to RGS, version 2.0 will be used.	FiscaalGemak.Core.Models.Enums.RgsVersion	None.
Rsin	Gets or sets the rsin of a client. This parameter is optional. If the rsin of a client is provided, the financial numbers document will be linked to this client containing the rsin. If the parameter is not provided, the ClientId or VatNumber parameter should be provided.	string	String length: inclusive between 0 and 9
VatNumber	Gets or sets the vatnumber of a client. This parameter is optional. If the vatnumber of a client is provided, the financial numbers document will be linked to this client containing the vatnumber. If the parameter is not provided, the ClientId or Rsin parameter should be provided.	string	String length: inclusive between 0 and 14

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "Files": [
    "sample string 1",
    "sample string 2"
  ],
  "ImportFileType": 0,
  "PeriodEnd": "2024-04-19T15:02:59.97473+02:00",
  "PeriodStart": "2024-04-19T15:02:59.97473+02:00",
  "RgsVersion": 1,
  "Rsin": "sample string 3",
  "VatNumber": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The FinancialNumbersDocumentResponseModel, containing information about the financial numbers document.

FiscaalGemak.Web.Api.Models.Models.FinancialNumbersDocumentResponseModel

Name	Description	Type	Additional information
ResponseCode		FiscaalGemak.Web.Api.Models.Enums.FinancialNumbersDocumentResponseCode	None.
ResponseMessage		string	None.

Response Formats

application/json, text/json

Sample:

Sample not available.