# PayrollAdministrationByPayrollAdministrationId Details of a payroll administration __Activity name :__ GetPayrollAdministrationByPayrollAdministrationId Get the details of a single payroll administration This is a read-only table function. The Loket.nl REST API may not support changing the data, or the Invantive UniversalSQL driver for Loket.nl REST does not support it. In the latter case, use the table NativePlatformScalarRequests to upload data to the Loket.nl REST API. - Catalog: `LoketNlRest` - Schema: `PayrollAdministration` ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `payrollAdministrationId` | `guid` | ☑ | | The unique identifier of an administration | ## Columns The columns of the table `PayrollAdministrationByPayrollAdministrationId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `address_city` | `string(24)` | City | ☐ | City of the address | | `address_country_isoCode` | `string(2)` | Country ISO Code | ☐ | The ISO 3166-1 alpha-2 value for the country | | `address_country_key` | `int32` | Country Key | ☐ | The key for the country. Possible values can be aquired via the metadata endpoint | | `address_country_value` | `string(50)` | Country Value | ☐ | The name of the country | | `address_furtherIndication_key` | `int32` | Address Further Indication Key | ☐ | The key of the further indication. Possible values can be aquired via the metadata endpoint | | `address_furtherIndication_value` | `string` | Address Further Indication Value | ☐ | The description of the further indication, the possible values are "WW" and "AB" | | `address_houseNumber` | `int32` | House Number | ☐ | House number of the address | | `address_houseNumberAddition` | `string(4)` | House Number Addition | ☐ | An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. | | `address_location` | `string(35)` | Location | ☐ | The location like to further specify the address | | `address_postalCode` | `string(9)` | Postal Code | ☐ | The postal code of the address | | `address_province_key` | `int32` | Address Province Key | ☐ | The key for the province. Possible values can be aquired via the metadata endpoint | | `address_province_value` | `string(50)` | Address Province Value | ☐ | The name of the province. Only the Dutch provices are supported and not translated | | `address_street` | `string(24)` | Street | ☐ | Streetname of the address | | `administrationNumber` | `string(15)` | Administration Number | ☐ | The administration number is a free field commonly used to register the debtors number. | | `cao_key` | `int32` | Collective Labour Agreement Key | ☐ | | | `cao_value` | `string(50)` | Collective Labour Agreement Value | ☐ | | | `claTaxReturnCBSCode` | `int32` | | ☐ | The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes. If no CLA is applicable than is field may be filled with value 9999. Please also note that this value might be empty (this is not recommended but it's possible). | | `clientNumber` | `int32` | Customer Number | ☐ | The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. | | `contact_name` | `string(50)` | Contact Person Name | ☐ | Name of the contact of the administration | | `contact_phoneNumber` | `string(15)` | Phone Number | ☐ | The general phone number of the administration | | `description` | `string(50)` | Description | ☐ | Description of the administration | | `deviatingPostalAddress_city` | `string(24)` | Deviating Postal Address City | ☐ | City of the address | | `deviatingPostalAddress_country_isoCode` | `string(2)` | Deviating Postal Address Country ISO Code | ☐ | The ISO 3166-1 alpha-2 value for the country | | `deviatingPostalAddress_country_key` | `int32` | Deviating Postal Address Country Key | ☐ | The key for the country. Possible values can be aquired by the metadata endpoint | | `deviatingPostalAddress_country_value` | `string(50)` | Deviating Postal Address Country Value | ☐ | The name of the country | | `deviatingPostalAddress_furtherIndication_key` | `int32` | Deviating Postal Address Further Indication Key | ☐ | The key of the further indication. Possible values can be aquired by the metadata endpoint | | `deviatingPostalAddress_furtherIndication_value` | `string` | Deviating Postal Address Further Indication Value | ☐ | The description of the further indication, the possible values are "WW" and "AB" | | `deviatingPostalAddress_houseNumber` | `int32` | Deviating Postal Address House Number | ☐ | House number of the address | | `deviatingPostalAddress_houseNumberAddition` | `string(4)` | Deviating Postal Address House Number Addition | ☐ | An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. | | `deviatingPostalAddress_location` | `string(35)` | Deviating Postal Address Location | ☐ | The location like to further specify the address | | `deviatingPostalAddress_poBox` | `int32` | Deviating Postal Address PO Box | ☐ | Post office box | | `deviatingPostalAddress_postalCode` | `string(9)` | Deviating Postal Address Postal Code | ☐ | The postal code of the address, only nullable if country is not The Netherlands (NL). | | `deviatingPostalAddress_street` | `string(24)` | Deviating Postal Address Street | ☐ | Streetname of the address | | `employerId` | `guid` | | ☐ | The id of the employer to which this payrolladministration belongs. | | `endDate` | `datetime` | End Date | ☐ | The last day the payroll administration is active. | | `groupClassification_key` | `int32` | | ☐ | | | `groupClassification_value` | `string` | | ☐ | | | `groupCode` | `int32` | Group Code | ☐ | Number (integer) used for grouping administrations. | | `id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `loonmodel_key` | `int32` | | ☐ | | | `loonmodel_value` | `string(50)` | | ☐ | | | `name` | `string(70)` | Name | ☐ | Name of the administration | | `payrollPeriodType_key` | `int32` | Payroll Processing Period Type Key | ☐ | | | `payrollPeriodType_value` | `string(50)` | Payroll Processing Period Type Value | ☐ | | | `payrollTaxesNumber` | `string(12)` | | ☐ | The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst. | | `shortName` | `string(12)` | Short Name | ☐ | Shortened name of the administration | | `startDate` | `datetime` | Start Date | ☐ | The first day the payroll administration is active. |