Loket.nl REST API Data Model
AttachmentOfEarningsByAttachmentOfEarningsId |
Get the details of an attachment of earnings record__Activity name :__ GetAttachmentOfEarningsByAttachmentOfEarningsIdGet the details of an attachment of earnings record
Catalog: LoketNlRest
Schema: AttachmentOfEarnings
This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.
Select loket.nl (REST) API URL: /providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}
Insert loket.nl (REST) API URL: /providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}
Update loket.nl (REST) API URL: /providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}
Delete loket.nl (REST) API URL: /providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}
Field Selection Method: NotRequired
Base Path: content
Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function AttachmentOfEarningsByAttachmentOfEarningsId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
attachmentOfEarningsId |
guid |
☑ |
|
The unique identifier of a record |
Table Function Columns
The columns of the table function AttachmentOfEarningsByAttachmentOfEarningsId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
beneficiary_city |
string(24) |
|
☐ |
City name of beneficiary |
beneficiary_name |
string(70) |
|
☐ |
Name of the beneficiary |
creditor_priority |
int32 |
|
☐ |
The priority of a creditor within the type of creditors. 0 is the highest priority followed by 1 etc. Priority dictates the order in which creditor receives their payment. The amount of earnings that can be used for payments can be limited (see attachment-exempt threshold). The system will then divide the available earnings starting with the creditor with the highest priority. If all available earnings are spend all other attachments will not receive payment until the time that earnings are available to meet them. |
creditor_type_key |
int32 |
|
☐ |
|
creditor_type_value |
string(50) |
|
☐ |
|
description1 |
string(32) |
|
☐ |
Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 |
string(32) |
|
☐ |
Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
descriptionPayslip |
string(14) |
|
☐ |
This value is shown on the payslip to identify the attachment. |
endDate |
datetime |
|
☐ |
The end date of the record |
fixedPaymentPerPayrollPeriod |
double |
|
☐ |
Set a fixed sum to be payed every payroll period.__Note:__ If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period. |
iban |
string(35) |
|
☐ |
International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
startDate |
datetime |
|
☐ |
Start date of this record__NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate). |
totalAmount_owed |
double |
|
☐ |
The total amount to be paid to the creditor |
totalAmount_paid_inApprovedPayrollRuns |
double |
|
☐ |
The total amount registerd in payroll run(s) with the status "approved". |
totalAmount_paid_inOpenPayrollRun |
double |
|
☐ |
The total amount registerd in payroll run(s) with the status "open". Note that open payroll runs are not final until they get approved, changes are posible until then. |
13-05-2022 15:37 Version 22.1.40-BETA+3374
