--- title: "Details of a payroll administration" method: GET path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}" tags: ["Payroll administration"] --- # Details of a payroll administration `GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}` - Auth: none required __Activity name :__ GetPayrollAdministrationByPayrollAdministrationId Get the details of a single payroll administration ## Path parameters - `payrollAdministrationId` string, uuid, required ## Headers - `Authorization` string, required - `Accept` string, required ## Response `200` OK - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `totalSize` integer: Total number of records, taking into account the given filter. - `pageSize` integer: Number of records in the response - `totalPages` integer: Number of pages available - `currentPage` integer: Current page returned in the response - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `content` PayrollAdministrationGet - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the administration - `shortName` string, nullable: Shortened name of the administration - `administrationNumber` string, nullable: The administration number is a free field commonly used to register the debtors number. - `clientNumber` integer: 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. - `description` string: Description of the administration - `startDate` string, date: The first day the payroll administration is active. - `endDate` string, date, nullable: The last day the payroll administration is active. - `cao` Cao: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to. - `key` integer - `value` string - `loonmodel` Loonmodel: The "loonmodel" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible. `loonmodel` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `groupClassification` GroupClassification, nullable: The group classification for the payroll administration. This field is used for filtering and grouping within the interface. `groupClassification` is a metadata field within the provider context. Possible values can be managed by the user. - `key` integer - `value` string - `groupCode` integer, nullable: Number (integer) used for grouping administrations. - `address` Address - `street` string: Streetname of the address - `city` string: City of the address - `houseNumber` integer: House number of the address - `houseNumberAddition` string, nullable: 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. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired via the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string: The postal code of the address - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired via the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `province` object, nullable: A Dutch province - `key` integer, nullable: The key for the province. Possible values can be aquired via the metadata endpoint - `value` string, nullable: The name of the province. Only the Dutch provices are supported and not translated - `deviatingPostalAddress` DeviatingPostalAddress, nullable - `street` string, nullable: Streetname of the address - `city` string: City of the address - `houseNumber` integer, nullable: House number of the address - `houseNumberAddition` string, nullable: 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. - `furtherIndication` object, nullable - `key` integer: The key of the further indication. Possible values can be aquired by the metadata endpoint - `value` string: The description of the further indication, the possible values are "WW" and "AB" - `postalCode` string, nullable: The postal code of the address, only nullable if country is not The Netherlands (NL). - `location` string, nullable: The location like to further specify the address - `country` object - `key` integer: The key for the country. Possible values can be aquired by the metadata endpoint - `value` string: The name of the country - `isoCode` string: The ISO 3166-1 alpha-2 value for the country - `poBox` integer, nullable: Post office box - `contact` Contact, nullable - `name` string, nullable: Name of the contact of the administration - `phoneNumber` string, nullable: The general phone number of the administration - `payrollPeriodType` PayrollPeriodType: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). - `key` integer - `value` string - `payrollTaxesNumber` string, nullable: The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst. - `claTaxReturnCBSCode` integer: The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes. If no CLA is applicable than use the value 9999. - `employerId` string, uuid: The id of the employer to which this payrolladministration belongs. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)