ROSEPEOPLE Developers - Web API Reference

Payroll | Deduction Report

Service to manage entities of type 'DeductionReport'.

Overview


URL api/{tenantKey}/{orgKey}/payrollCore/deductionReports
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET DeductionReports

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See DeductionReportResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /payrollCore/deductionReports

GET DeductionReports (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See DeductionReportResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /payrollCore/deductionReports?page={page}&pageSize={pageSize}

GET DeductionReport by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See DeductionReportResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /payrollCore/deductionReports/{id}

GET DeductionReport by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
deductionReportKey (string) Deduction Report.

Response:

When successful, the response body contains the entity record. See DeductionReportResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /payrollCore/deductionReports/{companyKey}/{deductionReportKey}

GET Print DeductionReport by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /payrollCore/deductionReports/{id}/print?template={template}

GET Print DeductionReport by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
deductionReportKey (string) Deduction Report.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/print

GET Original Print DeductionReportOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /payrollCore/deductionReports/{id}/printOriginal?template={template}

GET Original Print DeductionReport by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
deductionReportKey (string) Deduction Report.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/printOriginal

POST Operations

POST DeductionReports

Creates a new entity record.

The following elements are required:

deductionReportResource (ApiDeductionReportResource) The request body should contain the entity record that should be created.
See ApiDeductionReportResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiDeductionReportResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /payrollCore/deductionReports

POST Deduction Report

Inserts a new 'Deduction Report Detail' in the 'Deduction Report'.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (ApiDeductionReportDeductionReportDetailsResource) The ApiDeductionReportDeductionReportDetailsResource instance.
See ApiDeductionReportDeductionReportDetailsResource.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails

POST Generate Deduction Report

Custom operation 'GenerateDeductionReport'.

The following elements are required:

company (string) Company.
entity (string) Entity.
month (int) Month.
year (int) Year.
subscriberType (string) Indicates the type of subscriber that should be used for the report.
generateWithNoRows (bool) Indicates when the report should be created even if has no details.

Response:

When successful, the response body is empty.

Resource URL:

POST /payrollCore/deductionReports/generateDeductionReport/{company}/{entity}/{month}/{year}

PUT Operations

PUT Set Company DeductionReport

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/company

PUT Set CompanyValue DeductionReportDetail

Updates the value of attribute 'CompanyValue' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/companyValue

PUT Set Currency DeductionReport

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/currency

PUT Set Currency DeductionReportDetail

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/currency

PUT Set DeductionReportKey DeductionReport

Updates the value of attribute 'DeductionReportKey' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportKey

PUT Set DeductionReportState DeductionReport

Updates the value of attribute 'DeductionReportState' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (enum DeductionReportState) The request body should contain the new value for the attribute.
See DeductionReportState.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportState

PUT Set DeliveryDate DeductionReport

Updates the value of attribute 'DeliveryDate' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deliveryDate

PUT Set Description DeductionReport

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/description

PUT Set Employee DeductionReportDetail

Updates the value of attribute 'Employee' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/employee

PUT Set EmployeeValue DeductionReportDetail

Updates the value of attribute 'EmployeeValue' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/employeeValue

PUT Set Entity DeductionReport

Updates the value of attribute 'Entity' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/entity

PUT Set IsActive DeductionReport

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/isActive

PUT Set IsCalculated DeductionReportDetail

Updates the value of attribute 'IsCalculated' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/isCalculated

PUT Set IsModified DeductionReportDetail

Updates the value of attribute 'IsModified' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/isModified

PUT Set IsPrinted DeductionReport

Updates the value of attribute 'IsPrinted' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/isPrinted

PUT Set IsReprinted DeductionReport

Updates the value of attribute 'IsReprinted' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/isReprinted

PUT Set IsSigned DeductionReport

Updates the value of attribute 'IsSigned' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/isSigned

PUT Set Period DeductionReport

Updates the value of attribute 'Period' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/period

PUT Set PrintedReportName DeductionReport

Updates the value of attribute 'PrintedReportName' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/printedReportName

PUT Set SubjectValue DeductionReportDetail

Updates the value of attribute 'SubjectValue' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/subjectValue

PUT Set SubscriberId DeductionReportDetail

Updates the value of attribute 'SubscriberId' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}/subscriberId

PUT Set SubscriberType DeductionReport

Updates the value of attribute 'SubscriberType' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/subscriberType

PUT Set TotalCompanyValue DeductionReport

Updates the value of attribute 'TotalCompanyValue' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/totalCompanyValue

PUT Set TotalEmployeeValue DeductionReport

Updates the value of attribute 'TotalEmployeeValue' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/totalEmployeeValue

PUT Set TotalSubjectValue DeductionReport

Updates the value of attribute 'TotalSubjectValue' in the specified entity record.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/totalSubjectValue

DELETE Operations

DELETE Deduction Report Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

deductionReportKey (string) Deduction Report.
companyKey (string) The company key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /payrollCore/deductionReports/{companyKey}/{deductionReportKey}/deductionReportDetails/{lineId}

DELETE DeductionReport by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /payrollCore/deductionReports/{id}

DELETE DeductionReport by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
deductionReportKey (string) Deduction Report.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /payrollCore/deductionReports/{companyKey}/{deductionReportKey}

Resources


ApiDeductionReportDeductionReportDetailsProcessingDetailsResource

The following elements are required:

processing (string) Processing.
earning (string) Earning.
subjectValue (MoneyResource) Subject Value.
See MoneyResource .
exemptValue (MoneyResource) Exempt Value.
See MoneyResource .
freeValue (MoneyResource) Free Value.
See MoneyResource .
currency (string) Currency.


ApiDeductionReportDeductionReportDetailsResource

The following elements are required:

employee (string) Employee.
subjectValue (MoneyResource) Subject Value.
See MoneyResource .
employeeValue (MoneyResource) Employee Value.
See MoneyResource .
companyValue (MoneyResource) Company Value.
See MoneyResource .
currency (string) Currency.
isCalculated (bool) Is Calculated.
isModified (bool) Is Modified.

The following elements are optional:

subscriberId (string) Subscriber Id.
processingDetails (List of ApiDeductionReportDeductionReportDetailsProcessingDetailsResource) Processing Details.
See ApiDeductionReportDeductionReportDetailsProcessingDetailsResource.


ApiDeductionReportResource

The following elements are required:

deductionReportKey (string) Deduction Report.
period (DateTime) Period.
entity (string) Entity.
totalSubjectValue (MoneyResource) Total Subject Value.
See MoneyResource .
totalEmployeeValue (MoneyResource) Total Employee Value.
See MoneyResource .
totalCompanyValue (MoneyResource) Total Company Value.
See MoneyResource .
company (string) Company.
currency (string) Currency.
deductionReportState (enum DeductionReportState) State.
See DeductionReportState.

The following elements are optional:

description (string) Description.
subscriberType (string) Subscriber Type.
isPrinted (bool) Is Printed.
deductionReportDetails (List of ApiDeductionReportDeductionReportDetailsResource) Deduction Report Details.
See ApiDeductionReportDeductionReportDetailsResource.
deliveryDate (DateTime) Delivery Date.
printedReportName (string) Printed Report Name.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.


DeductionReportDetailResource

The following elements are required:

employee (string) Employee.
subjectValue (MoneyResource) Subject Value.
See MoneyResource .
employeeValue (MoneyResource) Employee Value.
See MoneyResource .
companyValue (MoneyResource) Company Value.
See MoneyResource .
currency (string) Currency.
isCalculated (bool) Is Calculated.
isModified (bool) Is Modified.

The following elements are optional:

subscriberId (string) Subscriber Id.
processingDetails (List of DeductionReportProcessingDetailResource) Processing Details.
See DeductionReportProcessingDetailResource.


DeductionReportMainDeductionReportDetailsResource

The following elements are required:

companyValue (MoneyResource) Company Value.
See MoneyResource .
currency (string) Currency.
employee (string) Employee.
employeeValue (MoneyResource) Employee Value.
See MoneyResource .
isCalculated (bool) Is Calculated.
subjectValue (MoneyResource) Subject Value.
See MoneyResource .
isModified (bool) Is Modified.

The following elements are optional:

subscriberId (string) Subscriber Id.


DeductionReportMainResource

The following elements are required:

company (string) Company.
currency (string) Currency.
deductionReportKey (string) Deduction Report.
entity (string) Entity.
period (DateTime) Period.
totalCompanyValue (MoneyResource) Total Company Value.
See MoneyResource .
totalEmployeeValue (MoneyResource) Total Employee Value.
See MoneyResource .
totalSubjectValue (MoneyResource) Total Subject Value.
See MoneyResource .
deductionReportState (enum DeductionReportState) State.
See DeductionReportState.

The following elements are optional:

deductionReportDetails (List of DeductionReportMainDeductionReportDetailsResource) Deduction Report Details.
See DeductionReportMainDeductionReportDetailsResource.
description (string) Description.
isPrinted (bool) Is Printed.
deliveryDate (DateTime) Delivery Date.
subscriberType (string) Subscriber Type.


DeductionReportProcessingDetailResource

The following elements are required:

processing (string) Processing.
earning (string) Earning.
subjectValue (MoneyResource) Subject Value.
See MoneyResource .
exemptValue (MoneyResource) Exempt Value.
See MoneyResource .
freeValue (MoneyResource) Free Value.
See MoneyResource .
currency (string) Currency.


DeductionReportResource

The following elements are required:

deductionReportKey (string) Deduction Report.
period (DateTime) Period.
entity (string) Entity.
(fk) Allowed value: the natural key of a record of type Party.
totalSubjectValue (MoneyResource) Total Subject Value.
See MoneyResource .
totalEmployeeValue (MoneyResource) Total Employee Value.
See MoneyResource .
totalCompanyValue (MoneyResource) Total Company Value.
See MoneyResource .
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company.
currency (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency.
deductionReportState (enum DeductionReportState) State.
See DeductionReportState.

The following elements are optional:

description (string) Description.
subscriberType (string) Subscriber Type.
(fk) Allowed value: the natural key of a record of type SubscriberType. These records are accessibly through the SubscriberTypes service.
isPrinted (bool) Is Printed.
deductionReportDetails (List of DeductionReportDetailResource) Deduction Report Details.
See DeductionReportDetailResource.
deliveryDate (DateTime) Delivery Date.
printedReportName (string) Printed Report Name.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



Enumerations


DeductionReportState

1 Processed
2 Exported
3 Sent
4 Failed