--- title: "Details of a journal allocation" method: GET path: "/v2/providers/employers/employees/employments/journalallocations/{journalAllocationId}" tags: ["Journal allocation"] --- # Details of a journal allocation `GET /v2/providers/employers/employees/employments/journalallocations/{journalAllocationId}` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/employees/employments/journalallocations/{journalAllocationId}` - Auth: none required __Activity name:__ GetJournalAllocationByJournalAllocationId Get the details of a financial journal allocation record (journaliseren module). ## Path parameters - `journalAllocationId` 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. - `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` JournalAllocationObject - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `journalProfileConfiguration` object: Indicates to which journal profiel configuration the record relates - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startPeriod` object - `year` integer: The year of the first payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `endPeriod` object, nullable - `year` integer: The year of the first payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `journalProfile` object - `key` integer - `value` string - `startPeriod` object - `year` integer: The year of the first payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `endPeriod` object, nullable - `year` integer: The year of the last payroll period for which the journal allocation is applicable. - `periodNumber` integer: The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable. - `periodStartDate` string, date: The first day of the payroll period. - `periodEndDate` string, date: The last day of the payroll period. - `allocationBasedOnActualHours` object, nullable: Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource. So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData, make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!). Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided. - `costCenter` CostCenterAllocationObject: The applicable cost center (=kostenplaats). `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `costUnit` CostUnitAllocationObject, nullable: The applicable cost center (=kostendrager). `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `allocationBasedOnFixedWeights` object[], nullable: Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case. Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. - `costCenter` CostCenterAllocationObject: The applicable cost center (=kostenplaats). `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `costUnit` CostUnitAllocationObject, nullable: The applicable cost center (=kostendrager). `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `code` string - `description` string - `weight` integer: The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit. ## 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)