Please enable JavaScript to view this site.

Navigation: » No topics above this level «

PayrollRunBalanceSheetByPayrollRunId__embeddedJournalAllocationAsJson

Get payroll run balance sheet__Activity name :__ GetPayrollRunBalanceSheetByPayrollRunIdThis endpoint returns per payroll components, marked as relevant for the general ledge (balance sheet), the sum of the values.If for the given payroll period of the payroll run a "journal profile" is configured the endpoint also returns the ledger account and costcenter/costunit linked to the given payroll component in the "journal profile"

Catalog: LoketNlRest

Schema: PayrollRunDownloads

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/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet

Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet

Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet

Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet

Field Selection Method: NotRequired

Base Path: _embedded[*].journalAllocation[*]

Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet

Table Function Parameters

The following parameters can be used to control the behaviour of the table function PayrollRunBalanceSheetByPayrollRunId__embeddedJournalAllocationAsJson. 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

payrollrunId

guid

 

The unique identifier of the payroll run

 

Table Function Columns

The columns of the table function PayrollRunBalanceSheetByPayrollRunId__embeddedJournalAllocationAsJson are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

costCenter_code

string(20)

 

The code of the cost center

costCenter_key

int32

 

The key of the cost center

costCenter_value

string(50)

 

The description of the cost center

costUnit_code

string(20)

 

The code of the cost unit

costUnit_key

int32

 

The key of the cost unit

costUnit_value

string(50)

 

The description of the cost unit

generalLedgerAccount_generalLedgerAccountnumber

string(20)

 

The account number for the general ledger account

generalLedgerAccount_key

int32

 

The key of the general ledger account

generalLedgerAccount_value

string(50)

 

The description of the general ledger account

payrollComponent_balanceSheetSide_key

int32

 

Indicates on what side (debit or credit) the value should go

payrollComponent_balanceSheetSide_value

string(50)

 

The description of the side of the balance sheet

payrollComponent_description

string(14)

 

The description of the payroll component

payrollComponent_key

int32

 

The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.

value

decimal

 

The sum of all the values for the payrollcomponent in the specific payroll run. Payroll period, employment and normal/tarif payslip are not taken into account and simply summed up.

 

13-05-2022 15:37 Version 22.1.40-BETA+3374