Payroll | Debt Procedure
Service to manage entities of type 'DebtProcedure'.
Overview
| URL | api/{tenantKey}/{orgKey}/payroll/debtProcedures | 
| Methods Supported | GET, POST, PUT, DELETE | 
All Operations
This service includes the following operations:
- GET:
 - POST:
 - 
                        PUT:
                        
- PUT Set IsActive DebtProcedure
 - PUT Set DebtProcedureKey DebtProcedure
 - PUT Set Contract DebtProcedure
 - PUT Set Company DebtProcedure
 - PUT Set Reference DebtProcedure
 - PUT Set DebtProcedureType DebtProcedure
 - PUT Set DebtProcedureStatus DebtProcedure
 - PUT Set Priority DebtProcedure
 - PUT Set Description DebtProcedure
 - PUT Set Executor DebtProcedure
 - PUT Set PaymentReference DebtProcedure
 - PUT Set StartPeriod DebtProcedure
 - PUT Set EndPeriod DebtProcedure
 - PUT Set TotalDebt DebtProcedure
 - PUT Set InitialAccumulated DebtProcedure
 - PUT Set TotalWithheld DebtProcedure
 - PUT Set BalanceWithheld DebtProcedure
 - PUT Set Currency DebtProcedure
 - PUT Set Remarks DebtProcedure
 - PUT Set DebtProcedureWithholding DebtProcedure
 - PUT Set WithholdingValue DebtProcedure
 - PUT Set WithholdingPercentage DebtProcedure
 - PUT Set PaymentMethod DebtProcedure
 - PUT Set PaymentTerm DebtProcedure
 - PUT Set StartPeriod DebtProcedureSuspension
 - PUT Set EndPeriod DebtProcedureSuspension
 - PUT Set SuspensionReason DebtProcedureSuspension
 
 - DELETE:
 
All Resources
This service uses the following resources:
- ApiDebtProcedureDebtProcedureSuspensionsResource
 - ApiDebtProcedureResource
 - DebtProcedureResource
 - DebtProcedureSuspensionResource
 - MoneyResource
 
All Enumerations
This service uses the following enumerations:
GET DebtProcedures
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See DebtProcedureResource. | 
Response status codes:
| 200 | OK. The operation was completed successfully. | 
| 400 | BadRequest. The request parameters are invalid. | 
Resource URL:
GET DebtProcedures (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 DebtProcedureResource. | 
Response status codes:
| 200 | OK. The operation was completed successfully. | 
| 400 | BadRequest. The request parameters are invalid. | 
Resource URL:
GET DebtProcedure 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 DebtProcedureResource. | 
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 DebtProcedure by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. | 
| debtProcedureKey | (string) Debt Procedure. | 
Response:
| When successful, the response body contains the entity record. See DebtProcedureResource. | 
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 DebtProcedure 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 DebtProcedure by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. | 
| debtProcedureKey | (string) Debt Procedure. | 
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 DebtProcedureOriginal 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 DebtProcedure by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. | 
| debtProcedureKey | (string) Debt Procedure. | 
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:
POST DebtProcedures
Creates a new entity record.
The following elements are required:
| debtProcedureResource | (ApiDebtProcedureResource) The request body should contain the entity record that should be created. See ApiDebtProcedureResource.  | 
                            
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 ApiDebtProcedureResource. | 
Response status codes:
| 201 | Created. The operation was completed successfully. | 
| 400 | BadRequest. The request parameters are invalid. | 
Resource URL:
POST Debt Procedure
Inserts a new 'Debt Procedure Suspension' in the 'Debt Procedure'.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| companyKey | (string) The company key. | 
| value | (ApiDebtProcedureDebtProcedureSuspensionsResource) The ApiDebtProcedureDebtProcedureSuspensionsResource instance. See ApiDebtProcedureDebtProcedureSuspensionsResource.  | 
                            
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:
PUT Set BalanceWithheld DebtProcedure
Updates the value of attribute 'BalanceWithheld' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 Company DebtProcedure
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 Contract DebtProcedure
Updates the value of attribute 'Contract' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 DebtProcedure
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 DebtProcedureKey DebtProcedure
Updates the value of attribute 'DebtProcedureKey' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 DebtProcedureStatus DebtProcedure
Updates the value of attribute 'DebtProcedureStatus' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| companyKey | (string) The company key. | 
| value | (enum DebtProcedureStatus) The request body should contain the new value for the attribute. See DebtProcedureStatus.  | 
                            
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 DebtProcedureType DebtProcedure
Updates the value of attribute 'DebtProcedureType' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 DebtProcedureWithholding DebtProcedure
Updates the value of attribute 'DebtProcedureWithholding' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| companyKey | (string) The company key. | 
| value | (enum DebtProcedureWithholding) The request body should contain the new value for the attribute. See DebtProcedureWithholding.  | 
                            
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 Description DebtProcedure
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 EndPeriod DebtProcedure
Updates the value of attribute 'EndPeriod' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 EndPeriod DebtProcedureSuspension
Updates the value of attribute 'EndPeriod' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 Executor DebtProcedure
Updates the value of attribute 'Executor' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 InitialAccumulated DebtProcedure
Updates the value of attribute 'InitialAccumulated' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 IsActive DebtProcedure
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 PaymentMethod DebtProcedure
Updates the value of attribute 'PaymentMethod' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 PaymentReference DebtProcedure
Updates the value of attribute 'PaymentReference' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 PaymentTerm DebtProcedure
Updates the value of attribute 'PaymentTerm' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 Priority DebtProcedure
Updates the value of attribute 'Priority' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 Reference DebtProcedure
Updates the value of attribute 'Reference' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 Remarks DebtProcedure
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 StartPeriod DebtProcedure
Updates the value of attribute 'StartPeriod' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 StartPeriod DebtProcedureSuspension
Updates the value of attribute 'StartPeriod' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 SuspensionReason DebtProcedureSuspension
Updates the value of attribute 'SuspensionReason' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 TotalDebt DebtProcedure
Updates the value of attribute 'TotalDebt' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 TotalWithheld DebtProcedure
Updates the value of attribute 'TotalWithheld' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 WithholdingPercentage DebtProcedure
Updates the value of attribute 'WithholdingPercentage' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 WithholdingValue DebtProcedure
Updates the value of attribute 'WithholdingValue' in the specified entity record.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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:
DELETE Debt Procedure Suspension by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| 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 DebtProcedure 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 DebtProcedure by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. | 
| debtProcedureKey | (string) Debt Procedure. | 
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
ApiDebtProcedureDebtProcedureSuspensionsResource
The following elements are required:
| startPeriod | (DateTime) Start Period. | 
The following elements are optional:
| endPeriod | (DateTime) End Period. | 
| suspensionReason | (string) Suspension Reason. | 
ApiDebtProcedureResource
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| contract | (string) Contract. | 
| company | (string) Company. | 
| debtProcedureType | (string) Debt Procedure Type. | 
| debtProcedureStatus | (enum DebtProcedureStatus) Debt Procedure Status.
									 See DebtProcedureStatus.  | 
                            
| priority | (int) Priority. | 
| executor | (string) Executor. | 
| paymentReference | (string) Payment Reference. | 
| startPeriod | (DateTime) Start Period. | 
| totalDebt | (MoneyResource) Total Debt.
												 See MoneyResource .  | 
                            
| initialAccumulated | (MoneyResource) Initial Accumulated.
												 See MoneyResource .  | 
                            
| totalWithheld | (MoneyResource) Total Withheld.
												 See MoneyResource .  | 
                            
| balanceWithheld | (MoneyResource) Balance Withheld.
												 See MoneyResource .  | 
                            
| currency | (string) Currency. | 
| debtProcedureWithholding | (enum DebtProcedureWithholding) Debt Procedure Withholding.
									 See DebtProcedureWithholding.  | 
                            
| withholdingValue | (MoneyResource) Withholding Value.
												 See MoneyResource .  | 
                            
| paymentMethod | (string) Payment Method. | 
| paymentTerm | (string) Payment Term. | 
The following elements are optional:
| reference | (string) Reference. | 
| description | (string) Description. | 
| endPeriod | (DateTime) End Period. | 
| remarks | (string) Remarks. | 
| debtProcedureSuspensions | (List of ApiDebtProcedureDebtProcedureSuspensionsResource) Debt Procedure Suspensions.
									 See ApiDebtProcedureDebtProcedureSuspensionsResource.  | 
                            
| withholdingPercentage | (decimal) Withholding Percentage. | 
DebtProcedureResource
The following elements are required:
| debtProcedureKey | (string) Debt Procedure. | 
| contract | (string) Contract.
									 (fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.  | 
                            
| company | (string) Company.
									 (fk) Allowed value: the natural key of a record of type Company.  | 
                            
| debtProcedureType | (string) Debt Procedure Type.
									 (fk) Allowed value: the natural key of a record of type DebtProcedureType. These records are accessibly through the DebtProcedureTypes service.  | 
                            
| debtProcedureStatus | (enum DebtProcedureStatus) Debt Procedure Status.
									 See DebtProcedureStatus.  | 
                            
| priority | (int) Priority. | 
| executor | (string) Executor.
									 (fk) Allowed value: the natural key of a record of type Party.  | 
                            
| paymentReference | (string) Payment Reference. | 
| startPeriod | (DateTime) Start Period. | 
| totalDebt | (MoneyResource) Total Debt.
												 See MoneyResource .  | 
                            
| initialAccumulated | (MoneyResource) Initial Accumulated.
												 See MoneyResource .  | 
                            
| totalWithheld | (MoneyResource) Total Withheld.
												 See MoneyResource .  | 
                            
| balanceWithheld | (MoneyResource) Balance Withheld.
												 See MoneyResource .  | 
                            
| currency | (string) Currency.
									 (fk) Allowed value: the natural key of a record of type Currency.  | 
                            
| debtProcedureWithholding | (enum DebtProcedureWithholding) Debt Procedure Withholding.
									 See DebtProcedureWithholding.  | 
                            
| withholdingValue | (MoneyResource) Withholding Value.
												 See MoneyResource .  | 
                            
| paymentMethod | (string) Payment Method.
									 (fk) Allowed value: the natural key of a record of type PaymentMethod.  | 
                            
| paymentTerm | (string) Payment Term.
									 (fk) Allowed value: the natural key of a record of type PaymentTerm.  | 
                            
The following elements are optional:
| reference | (string) Reference. | 
| description | (string) Description. | 
| endPeriod | (DateTime) End Period. | 
| remarks | (string) Remarks. | 
| debtProcedureSuspensions | (List of DebtProcedureSuspensionResource) Debt Procedure Suspensions.
									 See DebtProcedureSuspensionResource.  | 
                            
| withholdingPercentage | (decimal) Withholding Percentage. | 
DebtProcedureSuspensionResource
The following elements are required:
| startPeriod | (DateTime) Start Period. | 
The following elements are optional:
| endPeriod | (DateTime) End Period. | 
| suspensionReason | (string) Suspension Reason. | 
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.