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
Catalogus: LoketNlRest
Schema: AttachmentOfEarnings
Dit is een alleen-lezen tabelfunctie. De Loket.nl REST API biedt mogelijk geen ondersteuning voor het wijzigen van de data of het Invantive UniversalSQL-stuurprogramma voor Loket.nl REST ondersteunt dit niet. In het laatste geval gebruikt u de tabel NativePlatformScalarRequests om gegevens te uploaden naar de Loket.nl REST-API.
Parameters van Tabelfunctie
De volgende parameters kunnen worden gebruikt om het gedrag van de tabelfunctie AttachmentOfEarningsByAttachmentOfEarningsId in te stellen. Voor verplichte parameters moet altijd een waarde worden opgegeven, maar optionele parameters hoeven in het algemeen geen waarde te hebben en de uitvoering zal standaard een vooraf bepaald gedrag vertonen. Waarden kunnen worden gespecificeerd op basis van positie en naam. In beide gevallen worden alle niet-gespecificeerde parameters geëvalueerd aan de hand van hun standaardwaarden.
Waardespecificatie op positie gebeurt door alle waarden van de eerste tot de laatste benodigde waarde op te sommen. Bijvoorbeeld: een `select * uit tabel(waarde1, waarde2, waarde3)` op een tabel met vier parameters zal de standaardwaarde voor de vierde parameter gebruiken en de opgegeven waarden voor de eerste drie.
Waardespecificatie op naam gebeurt door alle waarden die een waarde vereisen op te sommen. Bijvoorbeeld met `selecteer * uit tabel(naam1 => waarde1, naam3 => waarde3)` op dezelfde tabel zullen de standaardwaarden voor de tweede en vierde parameter worden gebruikt en de opgegeven waarden voor de eerste en derde.
Naam |
Datatype |
Verplicht |
Standaardwaarde |
Documentatie |
|---|---|---|---|---|
attachmentOfEarningsId |
guid |
☑ |
|
The unique identifier of a record |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie AttachmentOfEarningsByAttachmentOfEarningsId worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
|---|---|---|---|---|
beneficiary_city |
string(24) |
Begunstigde Stad |
☐ |
City name of beneficiary |
beneficiary_name |
string(70) |
Naam Begunstigde |
☐ |
Name of the beneficiary |
creditor_priority |
int32 |
Prioriteit van Crediteur |
☐ |
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 |
Crediteursoortsleutel |
☐ |
|
creditor_type_value |
string(50) |
Crediteursoortwaarde |
☐ |
|
description1 |
string(32) |
Omschrijving 1 |
☐ |
Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file. |
description2 |
string(32) |
Omschrijving 2 |
☐ |
Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file. |
descriptionPayslip |
string(14) |
Betaalstrookomschrijving |
☐ |
This value is shown on the payslip to identify the attachment. |
endDate |
datetime |
Einddatum |
☐ |
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) |
IBAN |
☐ |
International Bank Account Number (IBAN). Only IBAN without spaces are accepted. |
id |
guid |
ID |
☐ |
The unique identifier of an object (GUID/UUID) |
startDate |
datetime |
Startdatum |
☐ |
Start date of this record |
totalAmount_owed |
double |
Totaal Verschuldigd Bedrag |
☐ |
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 possible until then. |
10-06-2024 18:51 Versie 24.1.3-BETA+4689
