Payroll | Contract

Service to manage entities of type 'Contract'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET Contracts
  • GET Contracts (paged)
  • GET Contract by identifier
  • GET Contract by key
  • GET Print Contract by identifier
  • GET Print Contract by key
  • GET Original Print ContractOriginal by identifier
  • GET Original Print Contract by key
  • GET Contract Picture.
• POST:
  • POST Contracts
  • POST Contract
  • POST Contract
  • POST Contract
  • POST Contract
  • POST Contract
  • POST Contract
  • POST Contract Create
  • POST Contract Renew
  • POST Contract Make Permanent
  • POST Contract Activate
  • POST Contract Abort
  • POST Contract Revert Last Decision
  • POST Contract Earning Update
• PUT:
  • PUT Set Custom Attribute Contract
  • PUT Set Custom Attribute ContractualPlan
  • PUT Set Custom Attribute ContractEarning
  • PUT Set Custom Attribute ContractDeduction
  • PUT Set Custom Attribute ContractBenefitAccount
  • PUT Set IsActive Contract
  • PUT Set ContractKey Contract
  • PUT Set ContractState Contract
  • PUT Set Employee Contract
  • PUT Set Picture Contract
  • PUT Set Company Contract
  • PUT Set HiringDate Contract
  • PUT Set HiringReason Contract
  • PUT Set TrialPeriodDays Contract
  • PUT Set TrialPeriodEndDate Contract
  • PUT Set EstimatedEndDate Contract
  • PUT Set EndDate Contract
  • PUT Set LeavingReason Contract
  • PUT Set WorkLocation Contract
  • PUT Set WorkTimeDuration Contract
  • PUT Set Remarks Contract
  • PUT Set HourlyWageFormula Contract
  • PUT Set HourlyWage Contract
  • PUT Set Currency Contract
  • PUT Set IsEditableHiringDate Contract
  • PUT Set SearchTerm Contract
  • PUT Set PaymentMethod Contract
  • PUT Set ContractActive Contract
  • PUT Set ProcessingStartPeriod Contract
  • PUT Set IBAN Contract
  • PUT Set SWIFT Contract
  • PUT Set Schedule Contract
  • PUT Set ContractPostingProfile Contract
  • PUT Set DimensionAllocationJson Contract
  • PUT Set NonWorkingDays Contract
  • PUT Set Profession Contract
  • PUT Set ProfessionalCategory Contract
  • PUT Set WorkRuleSet Contract
  • PUT Set Country Contract
  • PUT Set Department Contract
  • PUT Set ContractType ContractualPlan
  • PUT Set Duration ContractualPlan
  • PUT Set EmployeeExpiryPriorNotice ContractualPlan
  • PUT Set CompanyExpiryPriorNotice ContractualPlan
  • PUT Set ContractLineState ContractualPlan
  • PUT Set StartDate ContractualPlan
  • PUT Set EstimatedEndDate ContractualPlan
  • PUT Set EndDate ContractualPlan
  • PUT Set NextStepDecision ContractualPlan
  • PUT Set NextStage ContractualPlan
  • PUT Set TypeContract ContractualPlan
  • PUT Set Earning ContractEarning
  • PUT Set PeriodStart ContractEarning
  • PUT Set PeriodEnd ContractEarning
  • PUT Set QuantityKind ContractEarning
  • PUT Set QuantityValue ContractEarning
  • PUT Set QuantityFormula ContractEarning
  • PUT Set ValueKind ContractEarning
  • PUT Set ValueMoney ContractEarning
  • PUT Set ValueFormula ContractEarning
  • PUT Set Currency ContractEarning
  • PUT Set ReferenceDate ContractEarning
  • PUT Set Deduction ContractDeduction
  • PUT Set PeriodStart ContractDeduction
  • PUT Set PeriodEnd ContractDeduction
  • PUT Set CalculationKind ContractDeduction
  • PUT Set EmployeeValue ContractDeduction
  • PUT Set EmployeePercentage ContractDeduction
  • PUT Set EmployeeFormulaValue ContractDeduction
  • PUT Set EmployeeFormulaPercentage ContractDeduction
  • PUT Set Currency ContractDeduction
  • PUT Set BenefitAccountType ContractBenefitAccount
  • PUT Set Timing ContractBenefitAccount
  • PUT Set PeriodStart ContractBenefitAccount
  • PUT Set PeriodEnd ContractBenefitAccount
  • PUT Set AccountTypeByFormula ContractBenefitAccount
  • PUT Set DebitFormulaKind ContractBenefitAccount
  • PUT Set DebitFormula ContractBenefitAccount
  • PUT Set PaymentMethod ContractPaymentReference
  • PUT Set IBAN ContractPaymentReference
  • PUT Set SWIFT ContractPaymentReference
  • PUT Set Reference ContractPaymentReference
  • PUT Set Variable ContractGlobalVariable
  • PUT Set CurrentConfiguration ContractGlobalVariable
• DELETE:
  • DELETE Contractual Plan by identifier
  • DELETE Contract Earning by identifier
  • DELETE Contract Deduction by identifier
  • DELETE Contract Benefit Account by identifier
  • DELETE Contract Payment Reference by identifier
  • DELETE Contract Global Variable by identifier
  • DELETE Contract by identifier
  • DELETE Contract by key

All Resources

This service uses the following resources:

• ApiContractContractBenefitAccountsResource
• ApiContractContractDeductionsResource
• ApiContractContractEarningsResource
• ApiContractContractGlobalVariablesContractGlobalVariablePeriodsResource
• ApiContractContractGlobalVariablesResource
• ApiContractContractPaymentReferencesResource
• ApiContractContractualPlansResource
• ApiContractResource
• ContractBenefitAccountResource
• ContractDeductionResource
• ContractEarningResource
• ContractGlobalVariablePeriodResource
• ContractGlobalVariableResource
• ContractPaymentReferenceResource
• ContractResource
• ContractualPlanResource
• MainContractContractGlobalVariablesResource
• MainContractResource
• MoneyResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• BaseEarningClassification
• ContractBenefitAccountDebitFormulaKind
• ContractKind
• ContractLineState
• ContractState
• CustomTiming
• DeductionValueKind
• EarningValueKind
• HourlyWageFormula
• QuantityKind
• TypeContract
• WorkTimeDuration

GET Operations

GET Contracts

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET Contracts (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 ContractResource.

Response status codes:

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

Resource URL:

GET Contract 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 ContractResource.

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 Contract by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract.

Response:

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

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 Print Contract 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 Print Contract by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract.

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 Original Print ContractOriginal 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 Original Print Contract by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract.

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 Contract Picture.

Returns the value of attribute 'Picture' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image 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:

POST Operations

POST Contracts

Creates a new entity record.

The following elements are required:

contractResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiContractResource.

Response status codes:

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

Resource URL:

POST Contract

Inserts a new 'Contractual Plan' in the 'Contract'.

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(ApiContractContractualPlansResource) The ApiContractContractualPlansResource instance. See ApiContractContractualPlansResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Contract

Inserts a new 'Contract Earning' in the 'Contract'.

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(ApiContractContractEarningsResource) The ApiContractContractEarningsResource instance. See ApiContractContractEarningsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Contract

Inserts a new 'Contract Deduction' in the 'Contract'.

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(ApiContractContractDeductionsResource) The ApiContractContractDeductionsResource instance. See ApiContractContractDeductionsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Contract

Inserts a new 'Contract Benefit Account' in the 'Contract'.

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(ApiContractContractBenefitAccountsResource) The ApiContractContractBenefitAccountsResource instance. See ApiContractContractBenefitAccountsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Contract

Inserts a new 'Contract Payment Reference' in the 'Contract'.

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(ApiContractContractPaymentReferencesResource) The ApiContractContractPaymentReferencesResource instance. See ApiContractContractPaymentReferencesResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Contract

Inserts a new 'Contract Global Variable' in the 'Contract'.

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(ApiContractContractGlobalVariablesResource) The ApiContractContractGlobalVariablesResource instance. See ApiContractContractGlobalVariablesResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 Contract Create

Custom operation 'ContractCreate'.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a resource of type 'ContractResource'. See ContractResource.

Resource URL:

POST Contract Renew

Renew contract.

The following elements are required:

contractKey	(string) ContractKey.
companyKey	(string) CompanyKey.
endDate	(DateTime?) EndDate.
notes	(string) Notes.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

POST Contract Make Permanent

Contract make permanent.

The following elements are required:

contractKey	(string) ContractKey.
companyKey	(string) CompanyKey.
endDate	(DateTime?) EndDate.
notes	(string) Notes.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

POST Contract Activate

Contract Activate API.

The following elements are required:

contractKey	(string) ContractKey.
companyKey	(string) CompanyKey.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

POST Contract Abort

Contract Abort API.

The following elements are required:

contractKey	(string) ContractKey.
companyKey	(string) CompanyKey.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

POST Contract Revert Last Decision

Custom operation 'ContractRevertLastDecision'.

The following elements are required:

contractKey	(string) ContractKey.
companyKey	(string) CompanyKey.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

POST Contract Earning Update

Contract Earning Update.

The following elements are required:

contractKey	(string) ContractKey.
companyKey	(string) CompanyKey.
contractEarningId	(Guid) ContractEarningId.
quantityKindValue	(int) QuantityKindValue.
valueKindValue	(int) ValueKindValue.
quantityValue	(decimal) QuantityValue.
quantityFormula	(string) QuantityFormula.
valueMoney	(decimal) ValueMoney.
valueFormula	(string) ValueFormula.
referencePeriod	(DateTime?) ReferencePeriod.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

PUT Operations

PUT Set AccountTypeByFormula ContractBenefitAccount

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

The following elements are required:

contractKey	(string) Contract.
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 Set BenefitAccountType ContractBenefitAccount

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

The following elements are required:

contractKey	(string) Contract.
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 Set CalculationKind ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum DeductionValueKind) The request body should contain the new value for the attribute. See DeductionValueKind.

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 Set Company Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set CompanyExpiryPriorNotice ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) 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 Set ContractActive Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set ContractKey Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set ContractLineState ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum ContractLineState) The request body should contain the new value for the attribute. See ContractLineState.

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 Set ContractPostingProfile Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set ContractState Contract

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

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(enum ContractState) The request body should contain the new value for the attribute. See ContractState.

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 Set ContractType ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
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 Set Country Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set Currency Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set Currency ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
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 Set Currency ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
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 Set CurrentConfiguration ContractGlobalVariable

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

The following elements are required:

contractKey	(string) Contract.
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 Set DebitFormula ContractBenefitAccount

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

The following elements are required:

contractKey	(string) Contract.
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 Set DebitFormulaKind ContractBenefitAccount

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum ContractBenefitAccountDebitFormulaKind) The request body should contain the new value for the attribute. See ContractBenefitAccountDebitFormulaKind.

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 Set Deduction ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
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 Set Department Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set DimensionAllocationJson Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set Duration ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) 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 Set Earning ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
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 Set Employee Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set EmployeeExpiryPriorNotice ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) 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 Set EmployeeFormulaPercentage ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
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 Set EmployeeFormulaValue ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
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 Set EmployeePercentage ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
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 Set EmployeeValue ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
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 Set EndDate Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set EndDate ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set EstimatedEndDate Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set EstimatedEndDate ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set HiringDate Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set HiringReason Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set HourlyWage Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set HourlyWageFormula Contract

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

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(enum HourlyWageFormula) The request body should contain the new value for the attribute. See HourlyWageFormula.

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 Set IBAN Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set IBAN ContractPaymentReference

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

The following elements are required:

contractKey	(string) Contract.
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 Set IsActive Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set IsEditableHiringDate Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set LeavingReason Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set NextStage ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) 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 Set NextStepDecision ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
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 Set NonWorkingDays Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set PaymentMethod Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set PaymentMethod ContractPaymentReference

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

The following elements are required:

contractKey	(string) Contract.
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 Set PeriodEnd ContractBenefitAccount

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set PeriodEnd ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set PeriodEnd ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set PeriodStart ContractBenefitAccount

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set PeriodStart ContractDeduction

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set PeriodStart ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set Picture Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set ProcessingStartPeriod Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set Profession Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set ProfessionalCategory Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set QuantityFormula ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
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 Set QuantityKind ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum QuantityKind) The request body should contain the new value for the attribute. See QuantityKind.

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 Set QuantityValue ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
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 Set Reference ContractPaymentReference

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

The following elements are required:

contractKey	(string) Contract.
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 Set ReferenceDate ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set Remarks Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set Schedule Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set SearchTerm Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set StartDate ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
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 Set SWIFT Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set SWIFT ContractPaymentReference

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

The following elements are required:

contractKey	(string) Contract.
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 Set Timing ContractBenefitAccount

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum CustomTiming) The request body should contain the new value for the attribute. See CustomTiming.

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 Set TrialPeriodDays Contract

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

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(int) 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 Set TrialPeriodEndDate Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set TypeContract ContractualPlan

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum TypeContract) The request body should contain the new value for the attribute. See TypeContract.

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 Set ValueFormula ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
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 Set ValueKind ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum EarningValueKind) The request body should contain the new value for the attribute. See EarningValueKind.

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 Set ValueMoney ContractEarning

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

The following elements are required:

contractKey	(string) Contract.
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 Set Variable ContractGlobalVariable

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

The following elements are required:

contractKey	(string) Contract.
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 Set WorkLocation Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set WorkRuleSet Contract

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

The following elements are required:

contractKey	(string) Contract.
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 Set WorkTimeDuration Contract

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

The following elements are required:

contractKey	(string) Contract.
companyKey	(string) The company key.
value	(enum WorkTimeDuration) The request body should contain the new value for the attribute. See WorkTimeDuration.

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 Set Custom Attribute Contract

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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 Set Custom Attribute ContractualPlan

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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 Set Custom Attribute ContractEarning

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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 Set Custom Attribute ContractDeduction

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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 Set Custom Attribute ContractBenefitAccount

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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:

DELETE Operations

DELETE Contractual Plan by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

contractKey	(string) Contract.
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 Contract Earning by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

contractKey	(string) Contract.
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 Contract Deduction by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

contractKey	(string) Contract.
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 Contract Benefit Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

contractKey	(string) Contract.
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 Contract Payment Reference by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

contractKey	(string) Contract.
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 Contract Global Variable by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

contractKey	(string) Contract.
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 Contract 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 Contract by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
contractKey	(string) Contract.

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:

Resources

ApiContractContractBenefitAccountsResource

The following elements are required:

benefitAccountType	(string) Account Type.
periodStart	(DateTime) Start Period.

The following elements are optional:

timing	(enum CustomTiming) Timing. See CustomTiming.
periodEnd	(DateTime) End Period.
accountTypeByFormula	(bool) Account Type By Formula.
debitFormulaKind	(enum ContractBenefitAccountDebitFormulaKind) Debit Formula Kind. See ContractBenefitAccountDebitFormulaKind.
debitFormula	(string) Debit Formula.

ApiContractContractDeductionsResource

The following elements are required:

deduction	(string) Deduction.
periodStart	(DateTime) Start Period.
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

periodEnd	(DateTime) End Period.
calculationKind	(enum DeductionValueKind) Calculation Kind. See DeductionValueKind.
employeePercentage	(decimal) Employee %.
employeeFormulaValue	(string) Employee Formula Value.
employeeFormulaPercentage	(string) Employee Formula Percentage.

ApiContractContractEarningsResource

The following elements are required:

earning	(string) Earning.
periodStart	(DateTime) Start Period.
quantityValue	(decimal) Quantity Value.
valueMoney	(MoneyResource) Value Money. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

periodEnd	(DateTime) End Period.
quantityKind	(enum QuantityKind) Quantity Kind. See QuantityKind.
quantityFormula	(string) Quantity Formula.
valueKind	(enum EarningValueKind) Value Kind. See EarningValueKind.
valueFormula	(string) Value Formula.
referenceDate	(DateTime) Reference Date.

ApiContractContractGlobalVariablesContractGlobalVariablePeriodsResource

The following elements are required:

periodStart	(DateTime) Start Period.
value	(decimal) Value.

The following elements are optional:

periodEnd

(DateTime) Period End.

ApiContractContractGlobalVariablesResource

The following elements are required:

variable

(string) Variable.

The following elements are optional:

currentConfiguration	(string) Current Configuration.
contractGlobalVariablePeriods	(List of ApiContractContractGlobalVariablesContractGlobalVariablePeriodsResource) Contract Global Variable Periods. See ApiContractContractGlobalVariablesContractGlobalVariablePeriodsResource.

ApiContractContractPaymentReferencesResource

The following elements are required:

paymentMethod

(string) Payment Method.

The following elements are optional:

iBAN	(string) The finacial account's International Bank Account Number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
reference	(string) Reference.

ApiContractContractualPlansResource

The following elements are required:

contractType	(string) Stage.
contractLineState	(enum ContractLineState) State. See ContractLineState.
startDate	(DateTime) Start Date.
typeContract	(enum TypeContract) Type Contract. See TypeContract.

The following elements are optional:

duration	(int) Est. Duration.
employeeExpiryPriorNotice	(int) Emp. EPN.
companyExpiryPriorNotice	(int) Comp. EPN.
estimatedEndDate	(DateTime) Est. End Date.
endDate	(DateTime) End Date.
nextStepDecision	(bool) Next Step Decision.
nextStage	(Guid) Next Stage.

ApiContractResource

The following elements are required:

contractKey	(string) Contract.
contractState	(enum ContractState) State. See ContractState.
employee	(string) Employee.
company	(string) Company.
hiringDate	(DateTime) Hiring Date.
hiringReason	(string) Hiring Reason.
trialPeriodDays	(int) Trial Period Days.
workLocation	(string) Work Location.
workTimeDuration	(enum WorkTimeDuration) Work Time Duration. See WorkTimeDuration.
hourlyWageFormula	(enum HourlyWageFormula) Hourly Wage Formula. See HourlyWageFormula.
hourlyWage	(MoneyResource) Hourly Wage. See MoneyResource .
currency	(string) Currency.
paymentMethod	(string) Payment Method.
contractActive	(bool) Active.
processingStartPeriod	(DateTime) Processing Start Period.
contractPostingProfile	(string) Contract Posting Profile.
nonWorkingDays	(string) Non Working Days.
country	(string) Country.
contractKind	(enum ContractKind) Contract Kind. See ContractKind.
department	(string) Department.

The following elements are optional:

picture	(string) Picture.
trialPeriodEndDate	(DateTime) Trial Period End Date.
estimatedEndDate	(DateTime) Estimated End Date.
endDate	(DateTime) End Date.
leavingReason	(string) Leaving Reason.
contractualPlans	(List of ApiContractContractualPlansResource) Contractual Plans. See ApiContractContractualPlansResource.
contractEarnings	(List of ApiContractContractEarningsResource) Contract Earnings. See ApiContractContractEarningsResource.
contractDeductions	(List of ApiContractContractDeductionsResource) Contract Deductions. See ApiContractContractDeductionsResource.
remarks	(string) Remarks.
isEditableHiringDate	(bool) Is Editable Hiring Date.
searchTerm	(string) Atributo temporário até bug framework estar resolvido.
contractBenefitAccounts	(List of ApiContractContractBenefitAccountsResource) Contract Benefit Accounts. See ApiContractContractBenefitAccountsResource.
iBAN	(string) The finacial account's International Bank Account Number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
contractPaymentReferences	(List of ApiContractContractPaymentReferencesResource) Contract Payment References. See ApiContractContractPaymentReferencesResource.
schedule	(string) Schedule.
dimensionAllocationJson	(string) The json representation of the dimension allocation.
profession	(string) Profession.
professionalCategory	(string) Professional Category.
workRuleSet	(string) Work Rule Set.
contractGlobalVariables	(List of ApiContractContractGlobalVariablesResource) Contract Global Variables. See ApiContractContractGlobalVariablesResource.

ContractBenefitAccountResource

The following elements are required:

benefitAccountType	(string) Account Type.
periodStart	(DateTime) Start Period.

The following elements are optional:

timing	(enum CustomTiming) Timing. See CustomTiming.
periodEnd	(DateTime) End Period.
accountTypeByFormula	(bool) Account Type By Formula.
debitFormulaKind	(enum ContractBenefitAccountDebitFormulaKind) Debit Formula Kind. See ContractBenefitAccountDebitFormulaKind.
debitFormula	(string) Debit Formula.

ContractDeductionResource

The following elements are required:

deduction	(string) Deduction.
periodStart	(DateTime) Start Period.
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

periodEnd	(DateTime) End Period.
calculationKind	(enum DeductionValueKind) Calculation Kind. See DeductionValueKind.
employeePercentage	(decimal) Employee %.
employeeFormulaValue	(string) Employee Formula Value.
employeeFormulaPercentage	(string) Employee Formula Percentage.

ContractEarningResource

The following elements are required:

earning	(string) Earning.
periodStart	(DateTime) Start Period.
quantityValue	(decimal) Quantity Value.
valueMoney	(MoneyResource) Value Money. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

periodEnd	(DateTime) End Period.
quantityKind	(enum QuantityKind) Quantity Kind. See QuantityKind.
quantityFormula	(string) Quantity Formula.
valueKind	(enum EarningValueKind) Value Kind. See EarningValueKind.
valueFormula	(string) Value Formula.
referenceDate	(DateTime) Reference Date.
baseEarningClassification	(enum BaseEarningClassification) Base Earning Classification. See BaseEarningClassification.

ContractGlobalVariablePeriodResource

The following elements are required:

periodStart	(DateTime) Start Period.
value	(decimal) Value.

The following elements are optional:

periodEnd

(DateTime) Period End.

ContractGlobalVariableResource

The following elements are required:

variable

(string) Variable.

The following elements are optional:

currentConfiguration	(string) Current Configuration.
contractGlobalVariablePeriods	(List of ContractGlobalVariablePeriodResource) Contract Global Variable Periods. See ContractGlobalVariablePeriodResource.

ContractPaymentReferenceResource

The following elements are required:

paymentMethod

(string) Payment Method.

The following elements are optional:

iBAN	(string) The finacial account's International Bank Account Number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
reference	(string) Reference.

ContractResource

The following elements are required:

contractKey	(string) Contract.
contractState	(enum ContractState) State. See ContractState.
employee	(string) Employee.
company	(string) Company.
hiringDate	(DateTime) Hiring Date.
hiringReason	(string) Hiring Reason.
trialPeriodDays	(int) Trial Period Days.
workLocation	(string) Work Location.
workTimeDuration	(enum WorkTimeDuration) Work Time Duration. See WorkTimeDuration.
hourlyWageFormula	(enum HourlyWageFormula) Hourly Wage Formula. See HourlyWageFormula.
hourlyWage	(MoneyResource) Hourly Wage. See MoneyResource .
currency	(string) Currency.
paymentMethod	(string) Payment Method.
contractActive	(bool) Active.
processingStartPeriod	(DateTime) Processing Start Period.
contractPostingProfile	(string) Contract Posting Profile.
nonWorkingDays	(string) Non Working Days.
country	(string) Country.
contractKind	(enum ContractKind) Contract Kind. See ContractKind.
department	(string) Department.

The following elements are optional:

picture	(string) Picture.
trialPeriodEndDate	(DateTime) Trial Period End Date.
estimatedEndDate	(DateTime) Estimated End Date.
endDate	(DateTime) End Date.
leavingReason	(string) Leaving Reason.
contractualPlans	(List of ContractualPlanResource) Contractual Plans. See ContractualPlanResource.
contractEarnings	(List of ContractEarningResource) Contract Earnings. See ContractEarningResource.
contractDeductions	(List of ContractDeductionResource) Contract Deductions. See ContractDeductionResource.
remarks	(string) Remarks.
isEditableHiringDate	(bool) Is Editable Hiring Date.
searchTerm	(string) Atributo temporário até bug framework estar resolvido.
contractBenefitAccounts	(List of ContractBenefitAccountResource) Contract Benefit Accounts. See ContractBenefitAccountResource.
iBAN	(string) The finacial account's International Bank Account Number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
contractPaymentReferences	(List of ContractPaymentReferenceResource) Contract Payment References. See ContractPaymentReferenceResource.
schedule	(string) Schedule.
dimensionAllocationJson	(string) The json representation of the dimension allocation.
profession	(string) Profession.
professionalCategory	(string) Professional Category.
workRuleSet	(string) Work Rule Set.
contractGlobalVariables	(List of ContractGlobalVariableResource) Contract Global Variables. See ContractGlobalVariableResource.

ContractualPlanResource

The following elements are required:

contractType	(string) Stage.
contractLineState	(enum ContractLineState) State. See ContractLineState.
startDate	(DateTime) Start Date.
typeContract	(enum TypeContract) Type Contract. See TypeContract.

The following elements are optional:

duration	(int) Est. Duration.
employeeExpiryPriorNotice	(int) Emp. EPN.
companyExpiryPriorNotice	(int) Comp. EPN.
estimatedEndDate	(DateTime) Est. End Date.
endDate	(DateTime) End Date.
nextStepDecision	(bool) Next Step Decision.
nextStage	(Guid) Next Stage.

MainContractContractGlobalVariablesResource

The following elements are required:

variable

(string) Variable.

The following elements are optional:

currentConfiguration

(string) Current Configuration.

MainContractResource

The following elements are required:

contractKey	(string) Contract.
contractState	(enum ContractState) State. See ContractState.
company	(string) Company.
employee	(string) Employee.
hiringDate	(DateTime) Hiring Date.
hiringReason	(string) Hiring Reason.
trialPeriodDays	(int) Trial Period Days.
workLocation	(string) Work Location.
workTimeDuration	(enum WorkTimeDuration) Work Time Duration. See WorkTimeDuration.
hourlyWage	(MoneyResource) Hourly Wage. See MoneyResource .
hourlyWageFormula	(enum HourlyWageFormula) Hourly Wage Formula. See HourlyWageFormula.
paymentMethod	(string) Payment Method.
contractActive	(bool) Active.
processingStartPeriod	(DateTime) Processing Start Period.
contractPostingProfile	(string) Contract Posting Profile.
nonWorkingDays	(string) Non Working Days.
country	(string) Country.
contractKind	(enum ContractKind) Contract Kind. See ContractKind.
department	(string) Department.

The following elements are optional:

endDate	(DateTime) End Date.
estimatedEndDate	(DateTime) Estimated End Date.
leavingReason	(string) Leaving Reason.
picture	(string) Picture.
trialPeriodEndDate	(DateTime) Trial Period End Date.
remarks	(string) Remarks.
iBAN	(string) The finacial account's International Bank Account Number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
schedule	(string) Schedule.
dimensionAllocationJson	(string) The json representation of the dimension allocation.
profession	(string) Profession.
professionalCategory	(string) Professional Category.
workRuleSet	(string) Work Rule Set.
contractGlobalVariables	(List of MainContractContractGlobalVariablesResource) Contract Global Variables. See MainContractContractGlobalVariablesResource.

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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

BaseEarningClassification

1	Salary
2	SeniorityBonus
3	ChristmasAllowance
4	VacationAllowance
5	MealAllowance
6	SpecialDutyAllowance
7	HousingAllowance
8	TransportAllowance
9	RepresentationAllowance
10	LongTermBonus
11	ProductivityBonus
12	AttendanceBonus
13	HardshipAllowance
14	DangerousAllowance
15	UnhealthyWorkAllowance
16	ShiftWorkAllowance
17	CashiersAllowance
18	FamilyAllowance
19	Commissions
20	SubsistenceCosts
21	ScheduleExemption
22	OtherBonusAndRegularAllowances
23	ShareOfProfits
24	DistributionOfBondsOrOtherBonuses
25	OtherIrregularInstalments
26	ExceptionalIncreaseOvertime
27	ForceMajeurOvertime
28	Compensations
29	PaymentByVacationDays
30	Fees

ContractBenefitAccountDebitFormulaKind

1	Inherited
2	SpecificDebitFormula

ContractKind

1	Employment
2	Service

ContractLineState

1	Scheduled
2	Active
3	Executed
4	Aborted
5	Skipped

ContractState

1	NewContract
2	Active
3	Aborted
4	Outgoing
5	Finished

CustomTiming

1	Advance
2	Regular
3	Posterior
4	Inherited

DeductionValueKind

1	Money
2	Percentage
3	FormulaValue
4	FormulaPercentage

EarningValueKind

1	Money
2	Formula

HourlyWageFormula

1	Regular
2	FixedValue

QuantityKind

1	Value
2	Formula

TypeContract

1	LimitedTerm
2	Permanent
3	OpenTerm

WorkTimeDuration

1	FullTime
2	PartTime