{ "openapi": "3.0.4", "info": { "title": "Vsp.Journal", "description": "", "version": "v1" }, "servers": [ { "url": "/journal" } ], "paths": { "/providers/wagemodels/journalprofiles/{journalProfileId}/costcenters": { "get": { "tags": [ "Cost center at wage model level" ], "summary": "List of cost centers", "description": "**Activity name**:\n - `GetCostCentersAtWageModelLevelByJournalProfileId`\n\nRetrieves list of cost centers at wage model level by wage model id.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Cost center at wage model level" ], "summary": "Add a cost center", "description": "**Activity name**:\n - `PostCostCenterAtWageModelLevelByJournalProfileId`\n\nAdds a new cost center at wage model level.\n\n**Validation errors**:\n - `API_Journal_WageModelCostCenter_Code_NotUnique_ProviderLevel`\n - `API_Journal_WageModelCostCenter_Code_NotUnique_WageModelLevel`\n - `API_Journal_WageModelCostCenter_Code_NotUnique_PayrollAdministrationLevel`", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPostModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPostModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPostModel" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/costcenters/{costCenterId}": { "patch": { "tags": [ "Cost center at wage model level" ], "summary": "Edit a cost center", "description": "**Activity name**:\n - `PatchCostCenterAtWageModelLevelByJournalProfileId`\n\nEdits an existing cost center at wage model level by cost center id.\n\n**Validation errors**:\n - `API_Journal_WageModelCostCenter_Code_NotUnique_ProviderLevel`\n - `API_Journal_WageModelCostCenter_Code_NotUnique_WageModelLevel`\n - `API_Journal_WageModelCostCenter_Code_NotUnique_PayrollAdministrationLevel`", "parameters": [ { "name": "costCenterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPatchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPatchModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Cost center at wage model level" ], "summary": "Delete a cost center", "description": "**Activity name**:\n - `DeleteCostCenterAtWageModelLevelByCostCenterId`\n\nDeletes an existing cost center at wage model level by cost center id.\n\n**Validation errors**:\n - `API_Journal_WageModelCostCenter_InUse_CostCenterAtPayrollAdministrationLevel`\n - `API_Journal_WageModelCostCenter_InUse_PayrollComponentLink_WageModelLevel`\n - `API_Journal_WageModelCostCenter_InUse_PayrollComponentLink_PayrollAdministrationLevel`\n - `API_Journal_WageModelCostCenter_InUse_JournalAllocation`\n - `API_Journal_WageModelCostCenter_InUse_PayrollPeriodData`\n - `API_Journal_WageModelCostCenter_InUse_CostCenterCostUnitMatrix_WageModelLevel`\n - `API_Journal_WageModelCostCenter_InUse_CostCenterCostUnitMatrix_PayrollAdministrationLevel`", "parameters": [ { "name": "costCenterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/{journalProfileId}/costcentercostunitmatrix": { "get": { "tags": [ "Cost center cost unit matrix at wage model level" ], "summary": "List of cost center cost unit matrix entries", "description": "**Activity name**:\n - `GetCostCenterCostUnitMatrixAtWageModelLevelByJournalProfileId`\n\nRetrieves list of cost center cost unit matrix entries at wage model level by journal profile id.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Cost center cost unit matrix at wage model level" ], "summary": "Edit a cost center cost unit matrix entry", "description": "**Activity name**:\n - `PatchCostCenterCostUnitMatrixAtWageModelLevelByJournalProfileId `\n\nEdit the links between cost center and cost units at wage model level by journal profile id.\n\n**Validation errors**:\n - `API_Journal_WageModelCostCenterCostUnitMatrix_CostCenterCostUnit_NotUnique`: The specified cost center cost unit combination(s) cannot be set. One or more combinations have not been provided as unique.\n - `API_Journal_WageModelCostCenterCostUnitMatrix_CostCenter_NotExists`: The specified cost center cost unit combination(s) cannot be set. One or more cost centers do not exist.\n - `API_Journal_WageModelCostCenterCostUnitMatrix_CostUnit_NotExists`: The specified cost center cost unit combination(s) cannot be set. One or more cost centers do not exist.\n - `API_Journal_WageModelCostCenterCostUnitMatrix_CostCenterCostUnit_IsLocked`: One or more cost center and cost unit combinations are locked. It is not allowed to link or unlink a combination of cost center and cost unit that is locked.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixPatchModel" } } }, "text/json": { "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixPatchModel" } } }, "application/*+json": { "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixPatchModel" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/{journalProfileId}/costunits": { "get": { "tags": [ "Cost unit at wage model level" ], "summary": "List of cost units", "description": "**Activity name**:\n - `GetCostUnitsAtWageModelLevelByJournalProfileId`\n\nRetrieves list of cost units at wage model level by wage model id.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Cost unit at wage model level" ], "summary": "Add a cost unit", "description": "**Activity name**:\n - `PostCostUnitAtWageModelLevelByJournalProfileId`\n\nAdds a new cost unit at wage model level.\n\n**Validation errors**:\n - `API_Journal_WageModelCostUnit_Code_NotUnique_ProviderLevel`: Given code already exists for this journal profile and provider combination.\n - `API_Journal_WageModelCostUnit_Code_NotUnique_WageModelLevel`: Given code already exists for this journal profile and wage model combination.\n - `API_Journal_WageModelCostUnit_Code_NotUnique_PayrollAdministrationLevel`: Given code already exists for this journal profile and payroll administration combination.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPostModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPostModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPostModel" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/costunits/{costUnitId}": { "patch": { "tags": [ "Cost unit at wage model level" ], "summary": "Edit a cost unit", "description": "**Activity name**:\n - `PatchCostUnitAtWageModelLevelByJournalProfileId`\n\nEdits an existing cost unit at wage model level by cost unit id.\n\n**Validation errors**:\n - `API_Journal_WageModelCostUnit_Code_NotUnique_ProviderLevel`: Given code already exists for this journal profile and provider combination.\n - `API_Journal_WageModelCostUnit_Code_NotUnique_WageModelLevel`: Given code already exists for this journal profile and wage model combination.\n - `API_Journal_WageModelCostUnit_Code_NotUnique_PayrollAdministrationLevel`: Given code already exists for this journal profile and payroll administration combination.", "parameters": [ { "name": "costUnitId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPatchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPatchModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Cost unit at wage model level" ], "summary": "Delete a cost unit", "description": "**Activity name**:\n - `DeleteCostUnitAtWageModelLevelByCostUnitId`\n\nDeletes an existing cost unit at wage model level by cost unit id.\n\n**Validation errors**:\n - `API_Journal_WageModelCostUnit_InUse_CostUnitAtPayrollAdministrationLevel`: Given cost unit has deviations at the payroll administration level.\n - `API_Journal_WageModelCostUnit_InUse_PayrollComponentLink_WageModelLevel`: Given cost unit is still in use in the linked component to ledger account at wage model level.\n - `API_Journal_WageModelCostUnit_InUse_PayrollComponentLink_PayrollAdministrationLevel`: Given cost unit is still in use in the linked component to ledger account at payroll administration level.\n - `API_Journal_WageModelCostUnit_InUse_JournalAllocation`: Given cost unit is still in use as a journal allocation for an employment.\n - `API_Journal_WageModelCostUnit_InUse_PayrollPeriodData`: Given cost unit is still in use in payroll period data for an employment.\n - `API_Journal_WageModelCostUnit_InUse_CostUnitCostCenterMatrix_WageModelLevel`: Given cost unit is still in use in the cost center cost unit matrix at wage model level.\n - `API_Journal_WageModelCostUnit_InUse_CostUnitCostCenterMatrix_PayrollAdministrationLevel`: Given cost unit is still in use in the cost center cost unit matrix at payroll administration level.", "parameters": [ { "name": "costUnitId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/payrolladministrations/journalprofiles/{journalProfileId}": { "get": { "tags": [ "Journal profile at payroll administration level" ], "summary": "Get single journal profile", "description": "**Activity name**:\n - `GetJournalProfileAtPayrollAdministrationLevelByJournalProfileId`\nRetrieves single journal profile at payroll administration level by journal profile id.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Journal profile at payroll administration level" ], "summary": "Edit a journal profile", "description": "**Activity name**:\n - `PatchJournalProfileAtPayrollAdministrationLevelByJournalProfileId`\n\nEdits an existing journal profile at payroll administration level by journal profile id.\n\n**Validation errors**:\n - `API_Journal_PayrollAdministrationJournalProfile_Description_NotUnique_ProviderLevel`: Provided description for journal profile is already used at provider level.\n - `API_Journal_PayrollAdministrationJournalProfile_Description_NotUnique_WageModelLevel`: Provided description for journal profile is already used at wage model level.\n - `API_Journal_PayrollAdministrationJournalProfile_Description_NotUnique_PayrollAdministrationLevel`: Provided description for journal profile is already used at payroll administration level.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePatchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePatchModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Journal profile at payroll administration level" ], "summary": "Delete a journal profile", "description": "**Activity name**:\n - `DeleteJournalProfileAtPayrollAdministrationLevelByJournalProfileId`\n\nDeletes a journal profile at payroll administration level by journal profile id.\n\nWhen the journal profile deviates from an above lying journalprofile, it only removes the description deviation.\n\nIf the journal profile was created at payroll administration level, it will also delete underlying child entities.\n\n**Validation errors**:\n - `API_Journal_PayrollAdministrationJournalProfile_InUse_Journal`: The journal profile is in use by one or more journals.\n - `API_Journaal_PayrollAdministrationJournalProfile_CostUnit_Delete_InUse_PayrollPeriodData`: The cost unit is in use by one or more payroll period data.\n - `API_Journaal_PayrollAdministrationJournalProfile_CostUnit_Delete_InUse_JournalAllocation`: The cost unit is in use by one or more journal allocations.\n - `API_Journaal_PayrollAdministrationJournalProfile_CostCenter_Delete_InUse_PayrollPeriodData`: The cost center is in use by one or more payroll period data.\n - `API_Journaal_PayrollAdministrationJournalProfile_CostCenter_Delete_InUse_JournalAllocation`: The cost center is in use by one or more journal allocations.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/payrolladministrations/{payrollAdministrationId}/journalProfiles": { "post": { "tags": [ "Journal profile at payroll administration level" ], "summary": "Add a journal profile at payroll administration level.", "description": "**Activity name**:\n - `PostJournalProfileByPayrollAdministrationId`\n\nAdds a new journal profile at payroll administration level.\n\n**Validation errors**:/// \n - `API_Journal_PayrollAdministrationJournalProfile_Description_NotUnique_ProviderLevel`: Provided description for journal profile is already used at provider level.\n - `API_Journal_PayrollAdministrationJournalProfile_Description_NotUnique_WageModelLevel`: Provided description for journal profile is already used at wage model level.\n - `API_Journal_PayrollAdministrationJournalProfile_Description_NotUnique_PayrollAdministrationLevel`: Provided description for journal profile is already used at payroll administration level.", "parameters": [ { "name": "payrollAdministrationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePostModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePostModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePostModel" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/{wageModelId}/journalprofiles": { "get": { "tags": [ "Journal profile at wage model level" ], "summary": "List of journal profiles", "description": "**Activity name**:\n - `GetJournalProfilesByWageModelId`\n\nRetrieves list of journal profiles at wage model level by wage model id.", "parameters": [ { "name": "wageModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Journal profile at wage model level" ], "summary": "Add a journal profile", "description": "**Activity name**:\n - `PostJournalProfileByWageModelId`\n\nAdds a new journal profile at wage model level.\n\n**Validation errors**:\n - `API_Journal_WageModelJournalProfile_Description_NotUnique_ProviderLevel`\n - `API_Journal_WageModelJournalProfile_Description_NotUnique_WageModelLevel`\n - `API_Journal_WageModelJournalProfile_Description_NotUnique_PayrollAdministrationLevel`", "parameters": [ { "name": "wageModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePostModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePostModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePostModel" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/{journalProfileId}": { "get": { "tags": [ "Journal profile at wage model level" ], "summary": "Get single journal profile", "description": "**Activity name**:\n - `GetJournalProfileAtWageModelLevelByJournalProfileId`\nRetrieves single journal profile at wage model level by journal profile id.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Journal profile at wage model level" ], "summary": "Edit a journal profile", "description": "**Activity name**:\n - `PatchJournalProfileAtWageModelLevelByJournalProfileId`\n\nEdits an existing journal profile at wage model level by journal profile id.\n\n**Validation errors**:\n - `API_Journal_WageModelJournalProfile_Description_NotUnique_ProviderLevel`\n - `API_Journal_WageModelJournalProfile_Description_NotUnique_WageModelLevel`\n - `API_Journal_WageModelJournalProfile_Description_NotUnique_PayrollAdministrationLevel`", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePatchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePatchModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Journal profile at wage model level" ], "summary": "Delete a journal profile", "description": "**Activity name**:\n - `DeleteJournalProfileAtWageModelLevelByJournalProfileId`\n\nDeletes an existing journal profile at wage model level by journal profile id.\n\n**Validation errors**:\n - `API_Journal_WageModelJournalProfile_InUse_JournalProfileAtPayrollAdministrationLevel`\n - `API_Journal_WageModelJournalProfile_InUse_Journal`\n - `API_Journal_WageModelJournalProfile_InUse_WageModelLedgerAccount`\n - `API_Journal_WageModelJournalProfile_InUse_PayrollAdministrationLedgerAccount`\n - `API_Journal_WageModelJournalProfile_InUse_WageModelCostCenter`\n - `API_Journal_WageModelJournalProfile_InUse_PayrollAdministrationCostCenter`\n - `API_Journal_WageModelJournalProfile_InUse_WageModelCostUnit`\n - `API_Journal_WageModelJournalProfile_InUse_PayrollAdministrationCostUnit`", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/employers/payrolladministrations/{payrollAdministrationId}/journalConfigurations/{payrollPeriodId}/hasCostCenterCostUnit": { "get": { "tags": [ "JournalConfiguration" ], "parameters": [ { "name": "payrollAdministrationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "payrollPeriodId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalConfiguration.v20180101.Models.HasCostUnitCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalConfiguration.v20180101.Models.HasCostUnitCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalConfiguration.v20180101.Models.HasCostUnitCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/providers/employers/payrolladministrations/journalprofiles/{journalProfileId}/ledgeraccounts/import": { "post": { "tags": [ "Ledger account at payroll administration level" ], "summary": "Import a ledger account list", "description": "**Activity name**:\n - `PostLedgerAccountImportDataAtPayrollAdministrationLevelByJournalProfileId`\n\nImports a ledger account list at payroll administration level.\n\n**Validation errors**:\n - `API_ImportFileHeadersCouldNotBeFound` Not all columns can be found in file.\n - `API_ImportFileDataInvalid` Invalid content found in file.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.Shared.v20180101.Models.ImportFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.Shared.v20180101.Models.ImportFileModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.Shared.v20180101.Models.ImportFileModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.SystemNotifications.Models.TransactionInitiatedResult, Vsp.SystemNotifications, Version=9.1.2.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.SystemNotifications.Models.TransactionInitiatedResult, Vsp.SystemNotifications, Version=9.1.2.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.SystemNotifications.Models.TransactionInitiatedResult, Vsp.SystemNotifications, Version=9.1.2.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/providers/wagemodels/journalprofiles/{journalProfileId}/ledgeraccounts": { "get": { "tags": [ "Ledger account at wage model level" ], "summary": "List of ledger accounts", "description": "**Activity name**:\n - `GetLedgerAccountsAtWageModelLevelByJournalProfileId`\n\nRetrieves list of ledger accounts at wage model level by journal profile id.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Ledger account at wage model level" ], "summary": "Add a ledger account", "description": "**Activity name**:\n - `PostLedgerAccountAtWageModelLevelByJournalProfileId`\n\nAdds a new ledger account at wage model level.\n\n**Validation errors**:\n - `API_Journal_WageModelLedgerAccount_Number_AllZeros`\n - `API_Journal_WageModelLedgerAccount_Number_InUse_Provider`\n - `API_Journal_WageModelLedgerAccount_Number_InUse_Wagemodel`\n - `API_Journal_WageModelLedgerAccount_Number_InUse_LinkedPayrollAdministrations`", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPostModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPostModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPostModel" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/ledgeraccounts/{ledgerAccountId}": { "patch": { "tags": [ "Ledger account at wage model level" ], "summary": "Edit a ledger account", "description": "**Activity name**:\n - `PatchLedgerAccountAtWageModelLevelByLedgerAccountId`\n\nEdits an existing ledger account at wage model level by ledger account id.\n\n**Validation errors**:\n - `API_Journal_WageModelLedgerAccount_Number_AllZeros`\n - `API_Journal_WageModelLedgerAccount_Number_InUse_Provider`\n - `API_Journal_WageModelLedgerAccount_Number_InUse_Wagemodel`\n - `API_Journal_WageModelLedgerAccount_Number_InUse_LinkedPayrollAdministrations`\n - `API_Journal_WageModelLedgerAccount_CostAccount_InUse_PayrollComponentLink_Provider`\n - `API_Journal_WageModelLedgerAccount_CostAccount_InUse_PayrollComponentLink_WageModel`\n - `API_Journal_WageModelLedgerAccount_CostAccount_InUse_PayrollComponentLink_PayrollAdministration`", "parameters": [ { "name": "ledgerAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPatchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPatchModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Ledger account at wage model level" ], "summary": "Delete a ledger account", "description": "**Activity name**:\n - `DeleteLedgerAccountAtWageModelLevelByLedgerAccountId`\n\nDeletes an existing ledger account at wage model level by ledger account id.\n\n**Validation errors**:\n - `API_Journal_WageModelLedgerAccount_PayrollComponentLink_InUse_WageModel`\n - `API_Journal_WageModelLedgerAccount_PayrollComponentLink_InUse_PayrollAdministration`\n - `API_Journal_WageModelLedgerAccount_HasDeviations_PayrollAdministration`", "parameters": [ { "name": "ledgerAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/employers/payrolladministrations/journalprofiles/{journalProfileId}/ledgeraccounttopayrollcomponentlinks/import": { "post": { "tags": [ "Ledger account to payroll component link at payroll administration level" ], "summary": "Import a ledger account to payroll component link list (verdelingsschema)", "description": "**Activity name**:\n - `PostLedgerAccountToPayrollComponentLinkImportDataAtPayrollAdministrationLevelByJournalProfileId`\n\nImports a ledger account to payroll component link list at payroll administration level.\n\n**Validation errors**:\n - `API_ImportFileHeadersCouldNotBeFound` Not all columns can be found in file.\n - `API_ImportFileDataInvalid` Invalid content found in file.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.Shared.v20180101.Models.ImportFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.Shared.v20180101.Models.ImportFileModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.Shared.v20180101.Models.ImportFileModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.SystemNotifications.Models.TransactionInitiatedResult, Vsp.SystemNotifications, Version=9.1.2.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.SystemNotifications.Models.TransactionInitiatedResult, Vsp.SystemNotifications, Version=9.1.2.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.SystemNotifications.Models.TransactionInitiatedResult, Vsp.SystemNotifications, Version=9.1.2.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/providers/wagemodels/journalprofiles/{journalProfileId}/ledgeraccounttopayrollcomponentlinks": { "get": { "tags": [ "Ledger account to payroll component link at wage model level" ], "summary": "List of ledger account to payroll component links", "description": "**Activity name**:\n - `GetLedgerAccountToPayrollComponentLinksAtWageModelLevelByJournalProfileId`\n\nRetrieves list of ledger account to payroll component links at wage model level by journal profile id.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Ledger account to payroll component link at wage model level" ], "summary": "Add a ledger account to payroll component link", "description": "**Activity name**:\n - `PostLedgerAccountToPayrollComponentLinkAtWageModelLevelByJournalProfileId`\n\nAdds a new ledger account to payroll component link at wage model level.\n\nFor metadata see: `GetLedgerAccountToPayrollComponentLinkAtWageModelLevelMetadataByJournalProfileId`.\n\n**Validation errors**:\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Component_DoesNotExistInActiveYear`: Given payrollComponent does not exist for the wagemodel in the active payroll year.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Component_NotValidForJournal`: Given payrollComponent cannot be linked to a ledger account.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_CostAccountComponentAlreadyExists_Provider`: A payroll component linked to a ledger account configured as `costAccount` true cannot occur in the LedgerAccountToPayrollComponentLink together with a ledger account configured as `costAccount` false. Otherwise the account would not balance. Conflict found at provider level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_CostAccountComponentAlreadyExists_WageModel`: A payroll component linked to a ledger account configured as `costAccount` true cannot occur in the LedgerAccountToPayrollComponentLink together with a ledger account configured as `costAccount` false. Otherwise the account would not balance. Conflict found at wagemodel level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_CostAccountComponentAlreadyExists_PayrollAdministration`: A payroll component linked to a ledger account configured as `costAccount` true cannot occur in the LedgerAccountToPayrollComponentLink together with a ledger account configured as `costAccount` false. Otherwise the account would not balance. Conflict found at payroll administration level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostCenterCostUnit_InvalidCombination`: Given combination of `costCenter` and `costUnit` is not allowed.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostCenter_DoesNotExist`: Given costCenter.key does not exist for the wagemodel and journalprofile.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostUnit_DoesNotExist`: Given costUnit.key does not exist for the wagemodel and journalprofile.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_DoesNotExist`: Given ledgerAccount.key does not exist for the wagemodel and journalprofile.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonNvtForNonCostAccount`: For ledger accounts configured as `costAccount` false both costCenter and CostUnit must have the value n.v.t.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NvtForCostAccount`: For ledger accounts configured as `costAccount` true both costCenter and CostUnit cannot have the value n.v.t.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonCostAccountComponentAlreadyExists_Provider`: A payroll component linked to a ledger account configured as `costAccount` false cannot occur more than once in the LedgerAccountToPayrollComponentLink. Otherwise the account would not balance. Conflict found at provider level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonCostAccountComponentAlreadyExists_WageModel`: A payroll component linked to a ledger account configured as `costAccount` false cannot occur more than once in the LedgerAccountToPayrollComponentLink. Otherwise the account would not balance. Conflict found at wagemodel level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonCostAccountComponentAlreadyExists_PayrollAdministration`: A payroll component linked to a ledger account configured as `costAccount` false cannot occur more than once in the LedgerAccountToPayrollComponentLink. Otherwise the account would not balance. Conflict found at payroll administration level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Combination_InUse_Provider`: Given combination already exists for this journalprofile and wagemodel combination.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Combination_InUse_WageModel`: Given combination already exists for this journalprofile and wagemodel combination.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Combination_InUse_PayrollAdministration`: Given combination already exists for this journalprofile and wagemodel combination.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostCenterCostUnit_AlreadyCovered`: Given costUnit and costCenter combination is already covered by an existing link with the same ledger account and component.", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPostModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPostModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPostModel" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/ledgeraccounttopayrollcomponentlinks/{ledgerAccountToPayrollComponentLinkId}": { "patch": { "tags": [ "Ledger account to payroll component link at wage model level" ], "summary": "Edit a ledger account to payroll component link", "description": "**Activity name**:\n - `PatchLedgerAccountToPayrollComponentLinkAtWageModelLevelByLedgerAccountToPayrollComponentLinkId`\n\nEdits an existing ledger account to payroll component link at wage model level by ledger account to payroll component link id.\n\nFor metadata see: `GetLedgerAccountToPayrollComponentLinkAtWageModelLevelMetadataByLedgerAccountToPayrollComponentLinkId`.\n\n**Validation errors**:\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostCenterCostUnit_InvalidCombination`: Given combination of `costCenter` and `costUnit` is not allowed.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostCenter_DoesNotExist`: Given costCenter.key does not exist for the wagemodel and journalprofile.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostUnit_DoesNotExist`: Given costUnit.key does not exist for the wagemodel and journalprofile.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_DoesNotExist`: Given ledgerAccount.key does not exist for the wagemodel and journalprofile.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonNvtForNonCostAccount`: For ledger accounts configured as `costAccount` false both costCenter and CostUnit must have the value n.v.t.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NvtForCostAccount`: For ledger accounts configured as `costAccount` true both costCenter and CostUnit cannot have the value n.v.t.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonCostAccountComponentAlreadyExists_Provider`: A payroll component linked to a ledger account configured as `costAccount` false cannot occur more than once in the LedgerAccountToPayrollComponentLink. Otherwise the account would not balance. Conflict found at provider level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonCostAccountComponentAlreadyExists_WageModel`: A payroll component linked to a ledger account configured as `costAccount` false cannot occur more than once in the LedgerAccountToPayrollComponentLink. Otherwise the account would not balance. Conflict found at wagemodel level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_LedgerAccount_NonCostAccountComponentAlreadyExists_PayrollAdministration`: A payroll component linked to a ledger account configured as `costAccount` false cannot occur more than once in the LedgerAccountToPayrollComponentLink. Otherwise the account would not balance. Conflict found at payroll administration level.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Combination_InUse_Provider`: Given combination already exists for this journalprofile and wagemodel combination.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Combination_InUse_WageModel`: Given combination already exists for this journalprofile and wagemodel combination.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_Combination_InUse_PayrollAdministration`: Given combination already exists for this journalprofile and wagemodel combination.\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_CostCenterCostUnit_AlreadyCovered`: Given costUnit and costCenter combination is already covered by an existing link with the same ledger account and component.", "parameters": [ { "name": "ledgerAccountToPayrollComponentLinkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPatchModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPatchModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Ledger account to payroll component link at wage model level" ], "summary": "Delete a ledger account to payroll component link", "description": "**Activity name**:\n - `DeleteLedgerAccountToPayrollComponentLinkAtWageModelLevelByLedgerAccountToPayrollComponentLinkId`\n\nDeletes an existing ledger account to payroll component link at wage model level by ledger account to payroll component link id.\n\n**Validation errors**:\n - `API_Journal_WageModelLedgerAccountToPayrollComponentLink_HasDeviations`: Given record has deviations at payroll administration level in a �ledger account to payroll component link�.", "parameters": [ { "name": "ledgerAccountToPayrollComponentLinkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/{journalProfileId}/ledgeraccounttopayrollcomponentlinks/metadata": { "get": { "tags": [ "Ledger account to payroll component link at wage model level" ], "summary": "Get the metadata to add a new ledger account to payroll component link", "description": "**Activity name**:\n - `GetLedgerAccountToPayrollComponentLinkAtWageModelLevelMetadataByJournalProfileId`\n\nGet the metadata to add a new payroll component link at wage model level by journal profile id.\n\n**Metadata fields**:\n - `CostCenter`\n - `CostUnit`\n - `LedgerAccount`\n - `PayrollComponent`\n", "parameters": [ { "name": "journalProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/wagemodels/journalprofiles/ledgeraccounttopayrollcomponentlinks/{ledgerAccountToPayrollComponentLinkId}/metadata": { "get": { "tags": [ "Ledger account to payroll component link at wage model level" ], "summary": "Get the metadata to edit a new ledger account to payroll component link", "description": "**Activity name**:\n - `GetLedgerAccountToPayrollComponentLinkAtWageModelLevelMetadataByLedgerAccountToPayrollComponentLinkId`\n\nGet the metadata to edit a payroll component link at wage model level by ledger account to payroll component link id.\n\n**Metadata fields**:\n - `CostCenter`\n - `CostUnit`\n - `LedgerAccount`\n", "parameters": [ { "name": "ledgerAccountToPayrollComponentLinkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/report": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "payrollAdministrationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startPeriod", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "endPeriod", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "consolidate", "in": "query", "schema": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "default": 0 } }, { "name": "resultsPerPayrollPeriod", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.Interface.IFileModel, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.Interface.IFileModel, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.Interface.IFileModel, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } } }, "components": { "schemas": { "Vsp.ApiBase.Models.MetadataViewModel": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "options": { "type": "array", "items": { }, "nullable": true } }, "additionalProperties": false }, "Vsp.ApiBase.OpenApi.Examples.BadRequestDetailResponse": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestOperationMessage" }, "nullable": true }, "content": { "type": "integer", "format": "int32", "nullable": true }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" } }, "additionalProperties": false }, "Vsp.ApiBase.OpenApi.Examples.BadRequestListResponse": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.ApiBase.OpenApi.Examples.BadRequestOperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { }, "nullable": true }, "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" } }, "additionalProperties": false }, "Vsp.ApiBase.OpenApi.Examples.BadRequestOperationMessage": { "type": "object", "properties": { "messageCode": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "properties": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Vsp.ApiBase.OpenApi.Examples.ForbiddenResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Vsp.ApiBase.OpenApi.Examples.UnauthorizedResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.Interface.IFileModel, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Infrastructure.Interface.IFileModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Infrastructure.NoResult, Vsp.Infrastructure, Version=9.0.5.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Infrastructure.NoResult" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalConfiguration.v20180101.Models.HasCostUnitCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalConfiguration.v20180101.Models.HasCostUnitCostCenterModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel" } }, "additionalProperties": false }, "Vsp.Infrastructure.DetailResult`1[[Vsp.SystemNotifications.Models.TransactionInitiatedResult, Vsp.SystemNotifications, Version=9.1.2.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "content": { "$ref": "#/components/schemas/Vsp.SystemNotifications.Models.TransactionInitiatedResult" } }, "additionalProperties": false }, "Vsp.Infrastructure.Interface.IFileModel": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "mimeType": { "type": "string", "nullable": true }, "data": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ListResult`1[[Vsp.ApiBase.Models.MetadataViewModel, Vsp.ApiBase, Version=9.5.5.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.ApiBase.Models.MetadataViewModel" }, "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel" }, "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel" }, "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel" }, "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel" }, "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel" }, "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ListResult`1[[Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel, Vsp.Journal.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "version": { "$ref": "#/components/schemas/Vsp.Infrastructure.ResourceVersionModel" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Infrastructure.OperationMessage" }, "nullable": true }, "_embedded": { "type": "array", "items": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel" }, "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.NoResult": { "type": "object", "additionalProperties": false }, "Vsp.Infrastructure.OperationMessage": { "type": "object", "properties": { "messageCode": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "properties": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Vsp.Infrastructure.ResourceVersionModel": { "type": "object", "properties": { "obsoleteDate": { "type": "string", "format": "date", "nullable": true }, "resourceVersion": { "type": "string", "format": "date" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a shift (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "code": { "type": "string", "description": "The code for a cost center.", "nullable": true, "example": "1" }, "description": { "type": "string", "description": "The description for a cost center.", "nullable": true, "example": "SAL073" }, "automaticallyLinkToAllCostUnits": { "type": "boolean", "description": "Indicates whether this cost center will be automatically be linked to all cost units.\nNote: This field is no longer supported but due to backwards compatibility we return the value as readOnly. When creating a new record the value is set to \"false\".", "example": false, "deprecated": true }, "origin": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterOriginModel" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterOriginModel": { "type": "object", "properties": { "code": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "description": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "automaticallyLinkToAllCostUnits": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Level of inheritance:\n - 2 Wage model (WM)\n - 3 Payroll administration (PA)\n - 4 Provider" }, "Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPatchModel": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "maxLength": 20, "minLength": 1, "type": "string", "description": "The code for a cost center.", "nullable": true, "example": "1" }, "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for a cost center.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenter.v20180101.Models.WageModelCostCenterPostModel": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "maxLength": 20, "minLength": 1, "type": "string", "description": "The code for a cost center.", "nullable": true, "example": "1" }, "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for a cost center.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.CostCenterModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a cost center (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "code": { "type": "string", "description": "The code for a cost center.", "nullable": true, "example": "1" }, "description": { "type": "string", "description": "The description for a cost center.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.CostUnitModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a cost unit (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "code": { "type": "string", "description": "The code for a cost unit.", "nullable": true, "example": "1" }, "description": { "type": "string", "description": "The description for a cost unit.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixModel": { "type": "object", "properties": { "costCenter": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.CostCenterModel" }, "costUnit": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.CostUnitModel" }, "linked": { "type": "boolean", "description": "If `true` the given combination of cost center and cost unit are linked. Linked means that the combination can be selected in the \"Ledger account to payroll component mapping\" and \"journal allocation\" on employment level.", "example": true }, "locked": { "type": "boolean", "description": "If `true` the given link between cost center and cost unit is locked and cannot be disabled. This is due to the `automaticallyLinkToAllCostCenters` and `automaticallyLinkToAllCostUnits` fields.", "example": true } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixPatchModel": { "required": [ "costCenter", "costUnit" ], "type": "object", "properties": { "costCenter": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixPatchModel+LinkedItem" }, "costUnit": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixPatchModel+LinkedItem" }, "linked": { "type": "boolean", "description": "If true the given combination of cost center and cost unit are linked. \nLinked means that the combination can be selected in the \"Ledger account to payroll component mapping\" and \"journal allocation\" on employment level.", "example": true } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostCenterCostUnitMatrix.v20180101.Models.WageModelCostCenterCostUnitMatrixPatchModel+LinkedItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a cost unit (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a cost unit (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "code": { "type": "string", "description": "The code for a cost unit.", "nullable": true, "example": "1" }, "description": { "type": "string", "description": "The description for a cost unit.", "nullable": true, "example": "SAL073" }, "automaticallyLinkToAllCostCenters": { "type": "boolean", "description": "Indicates whether this cost unit will be automatically be linked to all cost centers.\nNote: This field is no longer supported but due to backwards compatibility we return the value as readOnly. When creating a new record the value is set to \"false\"", "example": false, "deprecated": true }, "origin": { "$ref": "#/components/schemas/Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitOriginModel" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitOriginModel": { "type": "object", "properties": { "code": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "description": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "automaticallyLinkToAllCostCenters": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Level of inheritance:\n - 2 Wage model (WM)\n - 3 Payroll administration (PA)\n - 4 Provider" }, "Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPatchModel": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "maxLength": 20, "minLength": 1, "type": "string", "description": "The code for a cost unit.", "nullable": true, "example": "1" }, "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for a cost unit.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.CostUnit.v20180101.Models.WageModelCostUnitPostModel": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "maxLength": 20, "minLength": 1, "type": "string", "description": "The code for a cost unit.", "nullable": true, "example": "1" }, "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for a cost unit.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.JournalConfiguration.v20180101.Models.HasCostUnitCostCenterModel": { "type": "object", "properties": { "hasCostCenterCostUnit": { "type": "boolean" } }, "additionalProperties": false }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a journal profile (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "key": { "type": "integer", "description": "The number of the journal profile.", "format": "int32", "example": 1 }, "description": { "type": "string", "description": "The description of the journal profile.", "nullable": true, "example": "Journal profile supermarkets" }, "origin": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileOriginModel" } }, "additionalProperties": false, "description": "Details of a journal profile at payroll administration level." }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfileOriginModel": { "type": "object", "properties": { "key": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "description": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Level of inheritance:\n - 2 Wage model (WM)\n - 3 Payroll administration (PA)\n - 4 Provider" }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePatchModel": { "type": "object", "properties": { "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for the journal profile.", "nullable": true, "example": "Journal profile supermarkets" } }, "additionalProperties": false, "description": "Patch model to modify a journal profile at payroll administration level." }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.PayrollAdministrationJournalProfilePostModel": { "required": [ "description" ], "type": "object", "properties": { "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for the journal profile.", "example": "Journal profile supermarkets" } }, "additionalProperties": false, "description": "Post model to add a new journal profile at payroll administration level." }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a shift (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "key": { "type": "integer", "description": "The number of the journal profile.", "format": "int32", "example": 1 }, "description": { "type": "string", "description": "The description of the journal profile.", "nullable": true, "example": "Journal profile supermarkets" }, "numberOfActiveAdministrations": { "type": "integer", "description": "The number of active usages of the journal profile.", "format": "int32", "example": 1 }, "numberOfHistoricAdministrations": { "type": "integer", "description": "The number of historical usages of the journal profile.", "format": "int32", "example": 1 }, "origin": { "$ref": "#/components/schemas/Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileOriginModel" } }, "additionalProperties": false, "description": "Details of a journal profile at wage model level." }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfileOriginModel": { "type": "object", "properties": { "key": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "description": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Level of inheritance:\n - 2 Wage model (WM)\n - 3 Payroll administration (PA)\n - 4 Provider" }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePatchModel": { "type": "object", "properties": { "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for the journal profile.", "nullable": true, "example": "Journal profile supermarkets" } }, "additionalProperties": false, "description": "Patch model to modify a journal profile at wage model level." }, "Vsp.Journal.Domain.JournalProfile.v20180101.Models.WageModelJournalProfilePostModel": { "required": [ "description" ], "type": "object", "properties": { "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for the journal profile.", "example": "Journal profile supermarkets" } }, "additionalProperties": false, "description": "Post model to add a new journal profile at wage model level." }, "Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a shift (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "number": { "type": "string", "description": "The \"number\" for a ledger account(is a string).", "nullable": true, "example": "SAL-4000" }, "description": { "type": "string", "description": "The description for a ledger account.", "nullable": true, "example": "Salary" }, "costAccount": { "type": "boolean", "description": "If set to true it is possible to devide costs for this account between cost centers and units.\nIf set to false it is not possible to devide costs for this account between cost centers and units.", "example": true }, "consolidate": { "type": "boolean", "description": "If set to true and multiple payrollcomponents are linked to this account only the sum of all values are booked.\nIf set to false and multiple payrollcomponents are linked to this account all individual values are booked.\nIf payroll component is not shown this will result in multiple lines with the same ledger account,\ncost center and cost unit probably with different values.", "example": true }, "origin": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountOriginModel" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountOriginModel": { "type": "object", "properties": { "number": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 2 }, "description": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 2 }, "costAccount": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 2 }, "consolidate": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 2 } }, "additionalProperties": false, "description": "Level of inheritance:\n - 2 Wage model (WM)\n - 3 Payroll administration (PA)\n - 4 Provider" }, "Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPatchModel": { "required": [ "consolidate", "costAccount", "description", "number" ], "type": "object", "properties": { "number": { "maxLength": 20, "minLength": 1, "type": "string", "description": "The \"number\" for a ledger account (is a string).", "nullable": true, "example": "SAL-4000" }, "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for a ledger account", "nullable": true, "example": "Salary" }, "costAccount": { "type": "boolean", "description": "If set to true it is possible to devide costs for this account between cost centers and units.\nIf set to false it is not possible to devide costs for this account between cost centers and units.", "example": true }, "consolidate": { "type": "boolean", "description": "If set to true and multiple payrollcomponents are linked to this account only the sum of all values are booked.\nIf set to false and multiple payrollcomponents are linked to this account all individual values are booked.\nIf payroll component is not shown this will result in multiple lines with the same ledger account,\ncost center and cost unit probably with different values.", "example": true } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccount.v20180101.Models.WageModelLedgerAccountPostModel": { "required": [ "consolidate", "costAccount", "description", "number" ], "type": "object", "properties": { "number": { "maxLength": 20, "minLength": 1, "type": "string", "description": "The \"number\" for a ledger account (is a string).", "nullable": true, "example": "SAL-4000" }, "description": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The description for a ledger account.", "nullable": true, "example": "Salary" }, "costAccount": { "type": "boolean", "description": "If set to true it is possible to devide costs for this account between cost centers and units.\nIf set to false it is not possible to devide costs for this account between cost centers and units.", "example": true }, "consolidate": { "type": "boolean", "description": "If set to true and multiple payrollcomponents are linked to this account only the sum of all values are booked.\nIf set to false and multiple payrollcomponents are linked to this account all individual values are booked.\nIf payroll component is not shown this will result in multiple lines with the same ledger account,\ncost center and cost unit probably with different values.", "example": true } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.BalanceSheetSideModel": { "type": "object", "properties": { "key": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.CategoryModel": { "type": "object", "properties": { "key": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.CostCenterMinimizedModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a cost center (GUID/UUID).", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "code": { "type": "string", "description": "The code for a cost center.", "nullable": true, "example": "1" }, "description": { "type": "string", "description": "The description for a cost center.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.CostUnitMinimizedModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a cost unit (GUID/UUID).", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "code": { "type": "string", "description": "The code for a cost unit.", "nullable": true, "example": "1" }, "description": { "type": "string", "description": "The description for a cost unit.", "nullable": true, "example": "SAL073" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.LedgerAccountMinimizedModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a ledger account (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "number": { "type": "string", "description": "The \"number\" for a ledger account(is a string).", "nullable": true, "example": "SAL-4000" }, "description": { "type": "string", "description": "The description for a ledger account.", "nullable": true, "example": "Salary" }, "costAccount": { "type": "boolean", "description": "If set to true it is possible to devide costs for this account between cost centers and units.\nIf set to false it is not possible to devide costs for this account between cost centers and units.", "example": true }, "consolidate": { "type": "boolean", "description": "If set to true and multiple payrollcomponents are linked to this account only the sum of all values are booked.\nIf set to false and multiple payrollcomponents are linked to this account all individual values are booked.\nIf payroll component is not shown this will result in multiple lines with the same ledger account,\ncost center and cost unit probably with different values.", "example": true } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.PayrollComponentModel": { "type": "object", "properties": { "key": { "type": "integer", "description": "The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.", "format": "int32", "example": 70 }, "description": { "type": "string", "description": "The description of the payroll component", "nullable": true, "example": "Wage" }, "category": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.CategoryModel" }, "balanceSheetSide": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.BalanceSheetSideModel" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelCostCenterPostPatchModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of an object (GUID/UUID)\nThis Id has two special options with meaning If `id` = null then this field is configured to not be relevant for the given ledgerAccount.\n(n.v.t) If `id` = a empty GUID then this record links the ledgerAccount to all costCenters that dont have their own unique line (Allemaal/Overig)", "format": "uuid", "nullable": true, "example": "012e3456-e89b-12d3-a456-426614174000" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelCostUnitPostPatchModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of an object (GUID/UUID)\nThis Id has two special options with meaning If `id` = null then this field is configured to not be relevant for the given ledgerAccount.\n(n.v.t) if `id` = a empty GUID then this record links the ledgerAccount to all costUnits that dont have their own unique line (Allemaal/Overig)", "format": "uuid", "nullable": true, "example": "012e3456-e89b-12d3-a456-426614174000" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountPostPatchModel": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of an object (GUID/UUID)", "format": "uuid", "example": "012e3456-e89b-12d3-a456-426614174000" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a ledger account to payroll component link (GUID/UUID).", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "ledgerAccount": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.LedgerAccountMinimizedModel" }, "payrollComponent": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.PayrollComponentModel" }, "costCenter": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.CostCenterMinimizedModel" }, "costUnit": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.CostUnitMinimizedModel" }, "origin": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkOriginModel" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkOriginModel": { "type": "object", "properties": { "ledgerAccount": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 2 }, "payrollComponent": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 4 }, "costCenter": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 2 }, "costUnit": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "example": 2 } }, "additionalProperties": false, "description": "Level of inheritance:\n - 2 Wage model (WM)\n - 3 Payroll administration (PA)\n - 4 Provider" }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPatchModel": { "required": [ "costCenter", "costUnit", "ledgerAccount" ], "type": "object", "properties": { "ledgerAccount": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountPostPatchModel" }, "costCenter": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelCostCenterPostPatchModel" }, "costUnit": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelCostUnitPostPatchModel" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountToPayrollComponentLinkPostModel": { "required": [ "costCenter", "costUnit", "ledgerAccount", "payrollComponent" ], "type": "object", "properties": { "ledgerAccount": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelLedgerAccountPostPatchModel" }, "payrollComponent": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelPayrollComponentPostModel" }, "costCenter": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelCostCenterPostPatchModel" }, "costUnit": { "$ref": "#/components/schemas/Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelCostUnitPostPatchModel" } }, "additionalProperties": false }, "Vsp.Journal.Domain.LedgerAccountToPayrollComponentLink.v20180101.Models.WageModelPayrollComponentPostModel": { "required": [ "key" ], "type": "object", "properties": { "key": { "type": "integer", "description": "The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.", "format": "int32", "example": 789 } }, "additionalProperties": false }, "Vsp.Journal.Domain.Shared.v20180101.Models.ImportFileModel": { "required": [ "data", "mimeType" ], "type": "object", "properties": { "mimeType": { "minLength": 1, "type": "string" }, "data": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Vsp.SystemNotifications.Models.TransactionInitiatedResult": { "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://oauth.loket.nl/token", "scopes": { } } } }, "Bearer": { "type": "apiKey", "description": "Authorization header using the Bearer scheme. \n Enter 'Bearer' [space] and then your token in the text input below.\nExample: \"Bearer 12345abcdef\"", "name": "Authorization", "in": "header" } } }, "security": [ { "oauth2": [ ] }, { "Bearer": [ ] } ], "tags": [ { "name": "Cost center at wage model level", "description": "Cost center at wage model level (NL: Kostenplaats op loonmodelniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Wage model" }, { "name": "Cost center cost unit matrix at wage model level", "description": "Cost center cost unit matrix at wage model level (NL: Kostenplaats kostendrager matrix op loonmodelniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Wage model" }, { "name": "Cost unit at wage model level", "description": "Cost unit at wage model level (NL: Kostendrager op loonmodelniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Wage model" }, { "name": "Journal profile at payroll administration level", "description": "Journal profile at payroll administration level (NL: Journaalprofiel op administratieniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Payroll administration" }, { "name": "Journal profile at wage model level", "description": "Journal profile at wage model level (NL: Journaalprofiel op loonmodelniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Wage model" }, { "name": "Ledger account at payroll administration level", "description": "Ledger account at payroll administration level (NL: Grootboekrekening op salarisverwerkende administratieniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Payroll administration" }, { "name": "Ledger account at wage model level", "description": "Ledger account at wage model level (NL: Grootboekrekening op loonmodelniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Wage model" }, { "name": "Ledger account to payroll component link at payroll administration level", "description": "Ledger account to payroll component link at payroll administration level (NL: Verdelingsschema op salarisverwerkende administratieniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Payroll administration" }, { "name": "Ledger account to payroll component link at wage model level", "description": "Ledger account to payroll component link at wage model level (NL: Verdelingsschema op loonmodelniveau)\n\n**Entity characteristics**:\n - Inheritance entity: YES\n - Inheritance level: Wage model" } ] }