{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key FIN API Specification", "description": "Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.", "termsOfService": "https://www.onkey.com/", "contact": { "name": "On Key Support", "url": "https://www.onkey.com/", "email": "onkey.support@pragmaworld.net" }, "license": { "name": "On Key Licence", "url": "https://www.onkey.com/" }, "version": "1.0.0" }, "host": ":443", "basePath": "/api/tenants/{client}/{connection}", "schemes": [ "https" ], "consumes": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitydelete+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entitycollection+json" ], "paths": { "/Modules/FIN/Budgets/{id}": { "get": { "tags": [ "Budget" ], "summary": "Get a Budget resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Budget->Code | string | |\r\n| createdByUserId | Budget->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Budget->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Budget->CreatedByUser_FullName | string | |\r\n| createdOn | Budget->CreatedOn | string | date-time |\r\n| modifiedByUserId | Budget->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Budget->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Budget->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Budget->ModifiedOn | string | date-time |\r\n| version | Budget->Version | integer | int32 |\r\n| permissionTreeId | Budget->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Budget->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Budget->PermissionTree_Description | string | |\r\n| siteId | Budget->Site_Id | integer | int64 |\r\n| siteCode | Budget->Site_Code | string | |\r\n| siteDescription | Budget->Site_Description | string | |\r\n| id | Budget->Id | integer | int64 |\r\n| baseCurrencyId | Budget->BaseCurrency_Id | integer | int64 |\r\n| baseCurrencyCode | Budget->BaseCurrency_Code | string | |\r\n| baseCurrencyDescription | Budget->BaseCurrency_Description | string | |\r\n| budgetActualAmount | Budget->BudgetActualAmount | number | decimal |\r\n| budgetActualAmountInBaseCurrency | Budget->BudgetActualAmountInBaseCurrency | number | decimal |\r\n| budgetAmount | Budget->BudgetAmount | number | decimal |\r\n| budgetAmountInBaseCurrency | Budget->BudgetAmountInBaseCurrency | number | decimal |\r\n| budgetTemplateId | Budget->BudgetTemplate_Id | integer | int64 |\r\n| budgetTemplateCode | Budget->BudgetTemplate_Code | string | |\r\n| budgetTemplateDescription | Budget->BudgetTemplate_Description | string | |\r\n| budgetVarianceAmount | Budget->BudgetVarianceAmount | number | decimal |\r\n| budgetVarianceAmountInBaseCurrency | Budget->BudgetVarianceAmountInBaseCurrency | number | decimal |\r\n| conversionRate | Budget->ConversionRate | number | decimal |\r\n| currencyId | Budget->Currency_Id | integer | int64 |\r\n| currencyCode | Budget->Currency_Code | string | |\r\n| currencyDescription | Budget->Currency_Description | string | |\r\n| description | Budget->Description | string | |\r\n| expression | Budget->Expression | string | |\r\n| financialYearPeriodId | Budget->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | Budget->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Budget->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | Budget->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | Budget->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Budget->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| notes | Budget->Notes | string | |\r\n| sequenceNumber | Budget->SequenceNumber | integer | int32 |\r\n| status | Budget->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n", "operationId": "GetBudget", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget", "schema": { "$ref": "#/definitions/GetBudgetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget" ], "summary": "Update an existing Budget resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Budget->Version | integer | int32 |\r\n| expression | Budget->Expression | string | |\r\n| status | Budget->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n| siteId | Budget->Site_Id | integer | int64 |\r\n| description | Budget->Description | string | |\r\n| code | Budget->Code | string | |\r\n| sequenceNumber | Budget->SequenceNumber | integer | int32 |\r\n| notes | Budget->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| expression | Nullable | False | |\r\n| description | Nullable | False | |\r\n| code | Nullable | False | |\r\n\r\n", "operationId": "UpdateBudget", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateBudgetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget" ], "summary": "Delete an existing Budget resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Budget->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteBudget", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteBudgetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets": { "get": { "tags": [ "Budget" ], "summary": "Get a collection of Budget resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Budget->Version | integer | int32 |\r\n| id | Budget->Id | integer | int64 |\r\n| code | Budget->Code | string | |\r\n| financialYearPeriodCode | Budget->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Budget->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearCode | Budget->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Budget->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| budgetAmount | Budget->BudgetAmount | number | decimal |\r\n| budgetActualAmount | Budget->BudgetActualAmount | number | decimal |\r\n| budgetVarianceAmount | Budget->BudgetVarianceAmount | number | decimal |\r\n| budgetAmountInBaseCurrency | Budget->BudgetAmountInBaseCurrency | number | decimal |\r\n| budgetActualAmountInBaseCurrency | Budget->BudgetActualAmountInBaseCurrency | number | decimal |\r\n| budgetVarianceAmountInBaseCurrency | Budget->BudgetVarianceAmountInBaseCurrency | number | decimal |\r\n| currencyCode | Budget->Currency_Code | string | |\r\n| currencyDescription | Budget->Currency_Description | string | |\r\n| baseCurrencyCode | Budget->BaseCurrency_Code | string | |\r\n| baseCurrencyDescription | Budget->BaseCurrency_Description | string | |\r\n| createdOn | Budget->CreatedOn | string | date-time |\r\n| modifiedOn | Budget->ModifiedOn | string | date-time |\r\n", "operationId": "GetBudgetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget collection", "schema": { "$ref": "#/definitions/GetBudgetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Budget" ], "summary": "Create a new Budget resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Budget->Code | string | |\r\n| permissionTreeId | Budget->PermissionTree_Id | integer | int64 |\r\n| financialYearPeriodId | Budget->FinancialYearPeriod_Id | integer | int64 |\r\n| expression | Budget->Expression | string | |\r\n| currencyId | Budget->Currency_Id | integer | int64 |\r\n| budgetAmount | Budget->BudgetAmount | number | decimal |\r\n| budgetTemplateId | Budget->BudgetTemplate_Id | integer | int64 |\r\n| description | Budget->Description | string | |\r\n| siteId | Budget->Site_Id | integer | int64 |\r\n| sequenceNumber | Budget->SequenceNumber | integer | int32 |\r\n| notes | Budget->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| financialYearPeriodId | Required | True | |\r\n| financialYearPeriodId | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n| currencyId | Required | True | |\r\n| currencyId | Nullable | False | |\r\n| budgetAmount | Required | True | |\r\n| budgetAmount | Nullable | False | |\r\n| budgetAmount | Min Value | >= 0| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n\r\n", "operationId": "CreateBudget", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateBudgetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Lookups/LookupBudgetBudgetTemplate": { "get": { "tags": [ "Budget" ], "summary": "Lookup the Budget Template for the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| code | BudgetTemplate->Code | string | |\r\n| description | BudgetTemplate->Description | string | |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n", "operationId": "LookupBudgetBudgetTemplate", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget Template collection", "schema": { "$ref": "#/definitions/BudgetBudgetTemplateLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Lookups/LookupBudgetChangePermissionTree": { "get": { "tags": [ "Budget" ], "summary": "Lookup the permission set for changing the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Lookups/LookupBudgetCurrency": { "get": { "tags": [ "Budget" ], "summary": "Lookup the Currency for the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupBudgetCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/BudgetCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Lookups/LookupBudgetFinancialYear": { "get": { "tags": [ "Budget" ], "summary": "Lookup the Financial Year for the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYear->Id | integer | int64 |\r\n| code | FinancialYear->Code | string | |\r\n| description | FinancialYear->Description | string | |\r\n", "operationId": "LookupBudgetFinancialYear", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year collection", "schema": { "$ref": "#/definitions/BudgetFinancialYearLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Lookups/LookupBudgetFinancialYearPeriod": { "get": { "tags": [ "Budget" ], "summary": "Lookup the Financial Year Period for the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupBudgetFinancialYearPeriod", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year Period collection", "schema": { "$ref": "#/definitions/BudgetFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Lookups/LookupBudgetInsertPermissionTree": { "get": { "tags": [ "Budget" ], "summary": "Lookup the permission set for creating the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Lookups/LookupBudgetSite": { "get": { "tags": [ "Budget" ], "summary": "Lookup the Site for the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| currencyCode | Site->Currency_Code | string | |\r\n| currencyDescription | Site->Currency_Description | string | |\r\n", "operationId": "LookupBudgetSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/BudgetSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Batch/{ids}": { "get": { "tags": [ "Budget" ], "summary": "Get a collection of Budget resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Budget->Code | string | |\r\n| createdByUserId | Budget->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Budget->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Budget->CreatedByUser_FullName | string | |\r\n| createdOn | Budget->CreatedOn | string | date-time |\r\n| modifiedByUserId | Budget->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Budget->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Budget->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Budget->ModifiedOn | string | date-time |\r\n| version | Budget->Version | integer | int32 |\r\n| permissionTreeId | Budget->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Budget->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Budget->PermissionTree_Description | string | |\r\n| siteId | Budget->Site_Id | integer | int64 |\r\n| siteCode | Budget->Site_Code | string | |\r\n| siteDescription | Budget->Site_Description | string | |\r\n| id | Budget->Id | integer | int64 |\r\n| baseCurrencyId | Budget->BaseCurrency_Id | integer | int64 |\r\n| baseCurrencyCode | Budget->BaseCurrency_Code | string | |\r\n| baseCurrencyDescription | Budget->BaseCurrency_Description | string | |\r\n| budgetActualAmount | Budget->BudgetActualAmount | number | decimal |\r\n| budgetActualAmountInBaseCurrency | Budget->BudgetActualAmountInBaseCurrency | number | decimal |\r\n| budgetAmount | Budget->BudgetAmount | number | decimal |\r\n| budgetAmountInBaseCurrency | Budget->BudgetAmountInBaseCurrency | number | decimal |\r\n| budgetTemplateId | Budget->BudgetTemplate_Id | integer | int64 |\r\n| budgetTemplateCode | Budget->BudgetTemplate_Code | string | |\r\n| budgetTemplateDescription | Budget->BudgetTemplate_Description | string | |\r\n| budgetVarianceAmount | Budget->BudgetVarianceAmount | number | decimal |\r\n| budgetVarianceAmountInBaseCurrency | Budget->BudgetVarianceAmountInBaseCurrency | number | decimal |\r\n| conversionRate | Budget->ConversionRate | number | decimal |\r\n| currencyId | Budget->Currency_Id | integer | int64 |\r\n| currencyCode | Budget->Currency_Code | string | |\r\n| currencyDescription | Budget->Currency_Description | string | |\r\n| description | Budget->Description | string | |\r\n| expression | Budget->Expression | string | |\r\n| financialYearPeriodId | Budget->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | Budget->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Budget->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | Budget->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | Budget->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Budget->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| notes | Budget->Notes | string | |\r\n| sequenceNumber | Budget->SequenceNumber | integer | int32 |\r\n| status | Budget->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n", "operationId": "BatchGetBudget", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Budget id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget collection", "schema": { "$ref": "#/definitions/BatchGetBudgetResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Batch": { "post": { "tags": [ "Budget" ], "summary": "Create a new collection of Budget resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Budget->Code | string | |\r\n| permissionTreeId | Budget->PermissionTree_Id | integer | int64 |\r\n| financialYearPeriodId | Budget->FinancialYearPeriod_Id | integer | int64 |\r\n| expression | Budget->Expression | string | |\r\n| currencyId | Budget->Currency_Id | integer | int64 |\r\n| budgetAmount | Budget->BudgetAmount | number | decimal |\r\n| budgetTemplateId | Budget->BudgetTemplate_Id | integer | int64 |\r\n| description | Budget->Description | string | |\r\n| siteId | Budget->Site_Id | integer | int64 |\r\n| sequenceNumber | Budget->SequenceNumber | integer | int32 |\r\n| notes | Budget->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| financialYearPeriodId | Required | True | |\r\n| financialYearPeriodId | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n| currencyId | Required | True | |\r\n| currencyId | Nullable | False | |\r\n| budgetAmount | Required | True | |\r\n| budgetAmount | Nullable | False | |\r\n| budgetAmount | Min Value | >= 0| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateBudget", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateBudgetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Budget batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget" ], "summary": "Update a collection of existing Budget resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Budget->Id | integer | int64 |\r\n| version | Budget->Version | integer | int32 |\r\n| expression | Budget->Expression | string | |\r\n| status | Budget->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n| siteId | Budget->Site_Id | integer | int64 |\r\n| description | Budget->Description | string | |\r\n| code | Budget->Code | string | |\r\n| sequenceNumber | Budget->SequenceNumber | integer | int32 |\r\n| notes | Budget->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| expression | Nullable | False | |\r\n| description | Nullable | False | |\r\n| code | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateBudget", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateBudgetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget" ], "summary": "Delete a collection of existing Budget resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Budget->Id | integer | int64 |\r\n| version | Budget->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteBudget", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteBudgetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/BudgetAmount/Batch": { "patch": { "tags": [ "Budget" ], "summary": "Batch Set Budget Amount", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SetBudgetAmount->Id | integer | int64 |\r\n| version | SetBudgetAmount->Version | integer | int32 |\r\n| budgetAmount | SetBudgetAmount->BudgetAmount | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| budgetAmount | Required | True | |\r\n| budgetAmount | Nullable | False | |\r\n\r\n", "operationId": "BatchSetBudgetAmount", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchSetBudgetAmountResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/{id}/PermissionTree": { "patch": { "tags": [ "Budget" ], "summary": "Change the PermissionTree for an existing Budget resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Budget->Version | integer | int32 |\r\n| permissionTreeId | Budget->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeBudgetPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeBudgetPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/{id}/BudgetAmount": { "patch": { "tags": [ "Budget" ], "summary": "Set Budget Amount", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetBudgetAmount->Version | integer | int32 |\r\n| budgetAmount | SetBudgetAmount->BudgetAmount | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| budgetAmount | Required | True | |\r\n| budgetAmount | Nullable | False | |\r\n\r\n", "operationId": "SetBudgetAmount", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/SetBudgetAmountResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/Batch/PermissionTree": { "patch": { "tags": [ "Budget" ], "summary": "Change the PermissionTree status for a collection of existing Budget resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Budget->Id | integer | int64 |\r\n| version | Budget->Version | integer | int32 |\r\n| permissionTreeId | Budget->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeBudgetPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeBudgetPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/{id}": { "get": { "tags": [ "Budget Parameter" ], "summary": "Get a Budget Parameter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | BudgetParameter->IsActive | boolean | |\r\n| createdByUserId | BudgetParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BudgetParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BudgetParameter->CreatedByUser_FullName | string | |\r\n| createdOn | BudgetParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | BudgetParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BudgetParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BudgetParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BudgetParameter->ModifiedOn | string | date-time |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | BudgetParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | BudgetParameter->PermissionTree_Description | string | |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| budgetId | BudgetParameter->Budget_Id | integer | int64 |\r\n| budgetBudgetAmount | BudgetParameter->Budget_BudgetAmount | number | decimal |\r\n| budgetCurrencyId | BudgetParameter->Budget_Currency_Id | integer | int64 |\r\n| budgetCurrencyCode | BudgetParameter->Budget_Currency_Code | string | |\r\n| budgetCurrencyDescription | BudgetParameter->Budget_Currency_Description | string | |\r\n| budgetFinancialYearPeriodId | BudgetParameter->Budget_FinancialYearPeriod_Id | integer | int64 |\r\n| budgetFinancialYearPeriodCode | BudgetParameter->Budget_FinancialYearPeriod_Code | string | |\r\n| budgetFinancialYearPeriodDescription | BudgetParameter->Budget_FinancialYearPeriod_Description | string | |\r\n| budgetFinancialYearPeriodFinancialYearId | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| budgetFinancialYearPeriodFinancialYearCode | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Code | string | |\r\n| budgetFinancialYearPeriodFinancialYearDescription | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Description | string | |\r\n| notes | BudgetParameter->Notes | string | |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| sequenceNumber | BudgetParameter->SequenceNumber | integer | int32 |\r\n| value | BudgetParameter->Value | object | composite |\r\n", "operationId": "GetBudgetParameter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Parameter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget Parameter", "schema": { "$ref": "#/definitions/GetBudgetParameterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget Parameter" ], "summary": "Update an existing Budget Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| value | BudgetParameter->Value | object | composite |\r\n| sequenceNumber | BudgetParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "UpdateBudgetParameter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateBudgetParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Parameter was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget Parameter" ], "summary": "Delete an existing Budget Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteBudgetParameter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Parameter Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteBudgetParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Parameter was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters": { "get": { "tags": [ "Budget Parameter" ], "summary": "Get a collection of Budget Parameter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| isActive | BudgetParameter->IsActive | boolean | |\r\n| sequenceNumber | BudgetParameter->SequenceNumber | integer | int32 |\r\n| value | BudgetParameter->Value | object | composite |\r\n| budgetId | BudgetParameter->Budget_Id | integer | int64 |\r\n| budgetFinancialYearPeriodCode | BudgetParameter->Budget_FinancialYearPeriod_Code | string | |\r\n| budgetFinancialYearPeriodDescription | BudgetParameter->Budget_FinancialYearPeriod_Description | string | |\r\n| budgetFinancialYearPeriodFinancialYearCode | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Code | string | |\r\n| budgetFinancialYearPeriodFinancialYearDescription | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Description | string | |\r\n", "operationId": "GetBudgetParameterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget Parameter collection", "schema": { "$ref": "#/definitions/GetBudgetParameterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Budget Parameter" ], "summary": "Create a new Budget Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| permissionTreeId | BudgetParameter->PermissionTree_Id | integer | int64 |\r\n| value | BudgetParameter->Value | object | composite |\r\n| budgetId | BudgetParameter->Budget_Id | integer | int64 |\r\n| sequenceNumber | BudgetParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| budgetId | Required | True | |\r\n| budgetId | Nullable | False | |\r\n\r\n", "operationId": "CreateBudgetParameter", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateBudgetParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budgets/{budgetId}/Parameters": { "get": { "tags": [ "Budget Parameter" ], "summary": "Get a collection of Budget Parameter resources for the Budget.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| budgetId | BudgetParameter->Budget_Id | integer | int64 |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| value | BudgetParameter->Value | object | composite |\r\n| isActive | BudgetParameter->IsActive | boolean | |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n", "operationId": "GetBudgetParameterForBudgetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "budgetId", "in": "path", "required": true, "description": "Budget Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget Parameter collection", "schema": { "$ref": "#/definitions/GetBudgetParameterForBudgetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/Lookups/LookupBudgetParameterChangePermissionTree": { "get": { "tags": [ "Budget Parameter" ], "summary": "Lookup the permission set for changing the Budget Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetParameterChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetParameterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/Lookups/LookupBudgetParameterInsertPermissionTree": { "get": { "tags": [ "Budget Parameter" ], "summary": "Lookup the permission set for creating the Budget Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetParameterInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetParameterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/Lookups/LookupBudgetParameterBudget": { "get": { "tags": [ "Budget Parameter" ], "summary": "Lookup the Budget for the Budget Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Budget->Id | integer | int64 |\r\n| currencyCode | Budget->Currency_Code | string | |\r\n| currencyDescription | Budget->Currency_Description | string | |\r\n| budgetAmount | Budget->BudgetAmount | number | decimal |\r\n| financialYearPeriodCode | Budget->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Budget->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearCode | Budget->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Budget->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| expression | Budget->Expression | string | |\r\n", "operationId": "LookupBudgetParameterBudget", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget collection", "schema": { "$ref": "#/definitions/BudgetParametersChangeDataTriggerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/Batch/{ids}": { "get": { "tags": [ "Budget Parameter" ], "summary": "Get a collection of Budget Parameter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | BudgetParameter->IsActive | boolean | |\r\n| createdByUserId | BudgetParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BudgetParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BudgetParameter->CreatedByUser_FullName | string | |\r\n| createdOn | BudgetParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | BudgetParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BudgetParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BudgetParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BudgetParameter->ModifiedOn | string | date-time |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | BudgetParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | BudgetParameter->PermissionTree_Description | string | |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| budgetId | BudgetParameter->Budget_Id | integer | int64 |\r\n| budgetBudgetAmount | BudgetParameter->Budget_BudgetAmount | number | decimal |\r\n| budgetCurrencyId | BudgetParameter->Budget_Currency_Id | integer | int64 |\r\n| budgetCurrencyCode | BudgetParameter->Budget_Currency_Code | string | |\r\n| budgetCurrencyDescription | BudgetParameter->Budget_Currency_Description | string | |\r\n| budgetFinancialYearPeriodId | BudgetParameter->Budget_FinancialYearPeriod_Id | integer | int64 |\r\n| budgetFinancialYearPeriodCode | BudgetParameter->Budget_FinancialYearPeriod_Code | string | |\r\n| budgetFinancialYearPeriodDescription | BudgetParameter->Budget_FinancialYearPeriod_Description | string | |\r\n| budgetFinancialYearPeriodFinancialYearId | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| budgetFinancialYearPeriodFinancialYearCode | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Code | string | |\r\n| budgetFinancialYearPeriodFinancialYearDescription | BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Description | string | |\r\n| notes | BudgetParameter->Notes | string | |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| sequenceNumber | BudgetParameter->SequenceNumber | integer | int32 |\r\n| value | BudgetParameter->Value | object | composite |\r\n", "operationId": "BatchGetBudgetParameter", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Budget Parameter id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget Parameter collection", "schema": { "$ref": "#/definitions/BatchGetBudgetParameterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/Batch": { "post": { "tags": [ "Budget Parameter" ], "summary": "Create a new collection of Budget Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| permissionTreeId | BudgetParameter->PermissionTree_Id | integer | int64 |\r\n| value | BudgetParameter->Value | object | composite |\r\n| budgetId | BudgetParameter->Budget_Id | integer | int64 |\r\n| sequenceNumber | BudgetParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| budgetId | Required | True | |\r\n| budgetId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateBudgetParameter", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateBudgetParameterRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Budget Parameter batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget Parameter" ], "summary": "Update a collection of existing Budget Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| parameterName | BudgetParameter->ParameterName | string | |\r\n| value | BudgetParameter->Value | object | composite |\r\n| sequenceNumber | BudgetParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateBudgetParameter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateBudgetParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Parameter batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget Parameter" ], "summary": "Delete a collection of existing Budget Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteBudgetParameter", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteBudgetParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Parameter batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/{id}/Active": { "patch": { "tags": [ "Budget Parameter" ], "summary": "Change the IsActive status for an existing Budget Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| isActive | BudgetParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeBudgetParameterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeBudgetParameterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Budget Parameter" ], "summary": "Change the PermissionTree for an existing Budget Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeBudgetParameterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeBudgetParameterPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/Batch/Active": { "patch": { "tags": [ "Budget Parameter" ], "summary": "Change the IsActive status for a collection of existing Budget Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| isActive | BudgetParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeBudgetParameterIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeBudgetParameterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Budget/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Budget Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Budget Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetParameter->Id | integer | int64 |\r\n| version | BudgetParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeBudgetParameterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeBudgetParameterPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/{id}": { "get": { "tags": [ "Budget Template" ], "summary": "Get a Budget Template resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | BudgetTemplate->Code | string | |\r\n| isActive | BudgetTemplate->IsActive | boolean | |\r\n| createdByUserId | BudgetTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BudgetTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BudgetTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | BudgetTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | BudgetTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BudgetTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BudgetTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BudgetTemplate->ModifiedOn | string | date-time |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplate->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | BudgetTemplate->PermissionTree_Code | string | |\r\n| permissionTreeDescription | BudgetTemplate->PermissionTree_Description | string | |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n| description | BudgetTemplate->Description | string | |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| isInitialised | BudgetTemplate->IsInitialised | boolean | |\r\n| isInitialisedReason | BudgetTemplate->IsInitialisedReason | string (Allowed values: [ExpressionOrParametersAreInvalid]) | enum |\r\n| notes | BudgetTemplate->Notes | string | |\r\n| sequenceNumber | BudgetTemplate->SequenceNumber | integer | int32 |\r\n", "operationId": "GetBudgetTemplate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget Template", "schema": { "$ref": "#/definitions/GetBudgetTemplateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget Template" ], "summary": "Update an existing Budget Template resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| code | BudgetTemplate->Code | string | |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n| description | BudgetTemplate->Description | string | |\r\n| sequenceNumber | BudgetTemplate->SequenceNumber | integer | int32 |\r\n| notes | BudgetTemplate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| expression | Nullable | False | |\r\n| budgetAmount | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateBudgetTemplate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateBudgetTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget Template" ], "summary": "Delete an existing Budget Template resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteBudgetTemplate", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteBudgetTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates": { "get": { "tags": [ "Budget Template" ], "summary": "Get a collection of Budget Template resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| code | BudgetTemplate->Code | string | |\r\n| description | BudgetTemplate->Description | string | |\r\n| sequenceNumber | BudgetTemplate->SequenceNumber | integer | int32 |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| isInitialised | BudgetTemplate->IsInitialised | boolean | |\r\n| isInitialisedReason | BudgetTemplate->IsInitialisedReason | string (Allowed values: [ExpressionOrParametersAreInvalid]) | enum |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n| isActive | BudgetTemplate->IsActive | boolean | |\r\n| notes | BudgetTemplate->Notes | string | |\r\n| createdOn | BudgetTemplate->CreatedOn | string | date-time |\r\n| modifiedOn | BudgetTemplate->ModifiedOn | string | date-time |\r\n", "operationId": "GetBudgetTemplateCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget Template collection", "schema": { "$ref": "#/definitions/GetBudgetTemplateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Budget Template" ], "summary": "Create a new Budget Template resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | BudgetTemplate->PermissionTree_Id | integer | int64 |\r\n| code | BudgetTemplate->Code | string | |\r\n| description | BudgetTemplate->Description | string | |\r\n| sequenceNumber | BudgetTemplate->SequenceNumber | integer | int32 |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n| notes | BudgetTemplate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| expression | Nullable | False | |\r\n| budgetAmount | Required | True | |\r\n| budgetAmount | Nullable | False | |\r\n\r\n", "operationId": "CreateBudgetTemplate", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateBudgetTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/Lookups/LookupBudgetTemplateChangePermissionTree": { "get": { "tags": [ "Budget Template" ], "summary": "Lookup the permission set for changing the Budget Template.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetTemplateChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetTemplateChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/Lookups/LookupBudgetTemplateInsertPermissionTree": { "get": { "tags": [ "Budget Template" ], "summary": "Lookup the permission set for creating the Budget Template.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetTemplateInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetTemplateInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/Batch/{ids}": { "get": { "tags": [ "Budget Template" ], "summary": "Get a collection of Budget Template resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | BudgetTemplate->Code | string | |\r\n| isActive | BudgetTemplate->IsActive | boolean | |\r\n| createdByUserId | BudgetTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BudgetTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BudgetTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | BudgetTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | BudgetTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BudgetTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BudgetTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BudgetTemplate->ModifiedOn | string | date-time |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplate->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | BudgetTemplate->PermissionTree_Code | string | |\r\n| permissionTreeDescription | BudgetTemplate->PermissionTree_Description | string | |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n| description | BudgetTemplate->Description | string | |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| isInitialised | BudgetTemplate->IsInitialised | boolean | |\r\n| isInitialisedReason | BudgetTemplate->IsInitialisedReason | string (Allowed values: [ExpressionOrParametersAreInvalid]) | enum |\r\n| notes | BudgetTemplate->Notes | string | |\r\n| sequenceNumber | BudgetTemplate->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetBudgetTemplate", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Budget Template id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget Template collection", "schema": { "$ref": "#/definitions/BatchGetBudgetTemplateResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/Batch": { "post": { "tags": [ "Budget Template" ], "summary": "Create a new collection of Budget Template resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | BudgetTemplate->PermissionTree_Id | integer | int64 |\r\n| code | BudgetTemplate->Code | string | |\r\n| description | BudgetTemplate->Description | string | |\r\n| sequenceNumber | BudgetTemplate->SequenceNumber | integer | int32 |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n| notes | BudgetTemplate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| expression | Nullable | False | |\r\n| budgetAmount | Required | True | |\r\n| budgetAmount | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateBudgetTemplate", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateBudgetTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Budget Template batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget Template" ], "summary": "Update a collection of existing Budget Template resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| code | BudgetTemplate->Code | string | |\r\n| expression | BudgetTemplate->Expression | string | |\r\n| budgetAmount | BudgetTemplate->BudgetAmount | number | decimal |\r\n| description | BudgetTemplate->Description | string | |\r\n| sequenceNumber | BudgetTemplate->SequenceNumber | integer | int32 |\r\n| notes | BudgetTemplate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| expression | Nullable | False | |\r\n| budgetAmount | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateBudgetTemplate", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateBudgetTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget Template" ], "summary": "Delete a collection of existing Budget Template resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteBudgetTemplate", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteBudgetTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/{id}/Active": { "patch": { "tags": [ "Budget Template" ], "summary": "Change the IsActive status for an existing Budget Template resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| isActive | BudgetTemplate->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeBudgetTemplateIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeBudgetTemplateIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/{id}/PermissionTree": { "patch": { "tags": [ "Budget Template" ], "summary": "Change the PermissionTree for an existing Budget Template resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplate->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeBudgetTemplatePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeBudgetTemplatePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/Batch/Active": { "patch": { "tags": [ "Budget Template" ], "summary": "Change the IsActive status for a collection of existing Budget Template resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| isActive | BudgetTemplate->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeBudgetTemplateIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeBudgetTemplateIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/Batch/PermissionTree": { "patch": { "tags": [ "Budget Template" ], "summary": "Change the PermissionTree status for a collection of existing Budget Template resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| version | BudgetTemplate->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplate->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeBudgetTemplatePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeBudgetTemplatePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/{id}": { "get": { "tags": [ "Budget Template Parameter" ], "summary": "Get a Budget Template Parameter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | BudgetTemplateParameter->IsActive | boolean | |\r\n| createdByUserId | BudgetTemplateParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BudgetTemplateParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BudgetTemplateParameter->CreatedByUser_FullName | string | |\r\n| createdOn | BudgetTemplateParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | BudgetTemplateParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BudgetTemplateParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BudgetTemplateParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BudgetTemplateParameter->ModifiedOn | string | date-time |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | BudgetTemplateParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | BudgetTemplateParameter->PermissionTree_Description | string | |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| budgetTemplateId | BudgetTemplateParameter->BudgetTemplate_Id | integer | int64 |\r\n| budgetTemplateCode | BudgetTemplateParameter->BudgetTemplate_Code | string | |\r\n| budgetTemplateDescription | BudgetTemplateParameter->BudgetTemplate_Description | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| notes | BudgetTemplateParameter->Notes | string | |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| sequenceNumber | BudgetTemplateParameter->SequenceNumber | integer | int32 |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n", "operationId": "GetBudgetTemplateParameter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Parameter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget Template Parameter", "schema": { "$ref": "#/definitions/GetBudgetTemplateParameterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget Template Parameter" ], "summary": "Update an existing Budget Template Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n| sequenceNumber | BudgetTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetTemplateParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| dataType | Nullable | False | |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "UpdateBudgetTemplateParameter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateBudgetTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template Parameter was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget Template Parameter" ], "summary": "Delete an existing Budget Template Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteBudgetTemplateParameter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteBudgetTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template Parameter was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters": { "get": { "tags": [ "Budget Template Parameter" ], "summary": "Get a collection of Budget Template Parameter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| isActive | BudgetTemplateParameter->IsActive | boolean | |\r\n| sequenceNumber | BudgetTemplateParameter->SequenceNumber | integer | int32 |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n| budgetTemplateId | BudgetTemplateParameter->BudgetTemplate_Id | integer | int64 |\r\n| budgetTemplateCode | BudgetTemplateParameter->BudgetTemplate_Code | string | |\r\n| budgetTemplateDescription | BudgetTemplateParameter->BudgetTemplate_Description | string | |\r\n", "operationId": "GetBudgetTemplateParameterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget Template Parameter collection", "schema": { "$ref": "#/definitions/GetBudgetTemplateParameterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Budget Template Parameter" ], "summary": "Create a new Budget Template Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| permissionTreeId | BudgetTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n| budgetTemplateId | BudgetTemplateParameter->BudgetTemplate_Id | integer | int64 |\r\n| sequenceNumber | BudgetTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetTemplateParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| budgetTemplateId | Required | True | |\r\n| budgetTemplateId | Nullable | False | |\r\n\r\n", "operationId": "CreateBudgetTemplateParameter", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateBudgetTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplates/{budgetTemplateId}/Parameters": { "get": { "tags": [ "Budget Template Parameter" ], "summary": "Get a collection of Budget Template Parameter resources for the Budget Template.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| budgetTemplateId | BudgetTemplateParameter->BudgetTemplate_Id | integer | int64 |\r\n| budgetTemplateDescription | BudgetTemplateParameter->BudgetTemplate_Description | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n| isActive | BudgetTemplateParameter->IsActive | boolean | |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n", "operationId": "GetBudgetTemplateParameterForBudgetTemplateCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "budgetTemplateId", "in": "path", "required": true, "description": "Budget Template Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget Template Parameter collection", "schema": { "$ref": "#/definitions/GetBudgetTemplateParameterForBudgetTemplateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/Lookups/LookupBudgetTemplateParameterBudgetTemplate": { "get": { "tags": [ "Budget Template Parameter" ], "summary": "Lookup the Budget Template for the Budget Template Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplate->Id | integer | int64 |\r\n| code | BudgetTemplate->Code | string | |\r\n| description | BudgetTemplate->Description | string | |\r\n", "operationId": "LookupBudgetTemplateParameterBudgetTemplate", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Budget Template collection", "schema": { "$ref": "#/definitions/BudgetTemplateParametersChangeDataTriggerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/Lookups/LookupBudgetTemplateParameterChangePermissionTree": { "get": { "tags": [ "Budget Template Parameter" ], "summary": "Lookup the permission set for changing the Budget Template Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetTemplateParameterChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetTemplateParameterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/Lookups/LookupBudgetTemplateParameterInsertPermissionTree": { "get": { "tags": [ "Budget Template Parameter" ], "summary": "Lookup the permission set for creating the Budget Template Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupBudgetTemplateParameterInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/BudgetTemplateParameterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/Batch/{ids}": { "get": { "tags": [ "Budget Template Parameter" ], "summary": "Get a collection of Budget Template Parameter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | BudgetTemplateParameter->IsActive | boolean | |\r\n| createdByUserId | BudgetTemplateParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BudgetTemplateParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BudgetTemplateParameter->CreatedByUser_FullName | string | |\r\n| createdOn | BudgetTemplateParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | BudgetTemplateParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BudgetTemplateParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BudgetTemplateParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BudgetTemplateParameter->ModifiedOn | string | date-time |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | BudgetTemplateParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | BudgetTemplateParameter->PermissionTree_Description | string | |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| budgetTemplateId | BudgetTemplateParameter->BudgetTemplate_Id | integer | int64 |\r\n| budgetTemplateCode | BudgetTemplateParameter->BudgetTemplate_Code | string | |\r\n| budgetTemplateDescription | BudgetTemplateParameter->BudgetTemplate_Description | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| notes | BudgetTemplateParameter->Notes | string | |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| sequenceNumber | BudgetTemplateParameter->SequenceNumber | integer | int32 |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n", "operationId": "BatchGetBudgetTemplateParameter", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Budget Template Parameter id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Budget Template Parameter collection", "schema": { "$ref": "#/definitions/BatchGetBudgetTemplateParameterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/Batch": { "post": { "tags": [ "Budget Template Parameter" ], "summary": "Create a new collection of Budget Template Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| permissionTreeId | BudgetTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n| budgetTemplateId | BudgetTemplateParameter->BudgetTemplate_Id | integer | int64 |\r\n| sequenceNumber | BudgetTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetTemplateParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| budgetTemplateId | Required | True | |\r\n| budgetTemplateId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateBudgetTemplateParameter", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateBudgetTemplateParameterRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Budget Template Parameter batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Budget Template Parameter" ], "summary": "Update a collection of existing Budget Template Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| parameterName | BudgetTemplateParameter->ParameterName | string | |\r\n| dataType | BudgetTemplateParameter->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| value | BudgetTemplateParameter->Value | object | composite |\r\n| sequenceNumber | BudgetTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | BudgetTemplateParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| dataType | Nullable | False | |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateBudgetTemplateParameter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateBudgetTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template Parameter batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Budget Template Parameter" ], "summary": "Delete a collection of existing Budget Template Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteBudgetTemplateParameter", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteBudgetTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Budget Template Parameter batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/{id}/Active": { "patch": { "tags": [ "Budget Template Parameter" ], "summary": "Change the IsActive status for an existing Budget Template Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| isActive | BudgetTemplateParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeBudgetTemplateParameterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeBudgetTemplateParameterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Budget Template Parameter" ], "summary": "Change the PermissionTree for an existing Budget Template Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplateParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeBudgetTemplateParameterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Budget Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeBudgetTemplateParameterPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/Batch/Active": { "patch": { "tags": [ "Budget Template Parameter" ], "summary": "Change the IsActive status for a collection of existing Budget Template Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| isActive | BudgetTemplateParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeBudgetTemplateParameterIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeBudgetTemplateParameterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/BudgetTemplate/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Budget Template Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Budget Template Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | BudgetTemplateParameter->Id | integer | int64 |\r\n| version | BudgetTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | BudgetTemplateParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeBudgetTemplateParameterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeBudgetTemplateParameterPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/{id}": { "get": { "tags": [ "Cost Centre" ], "summary": "Get a Cost Centre resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | CostCentre->Code | string | |\r\n| isActive | CostCentre->IsActive | boolean | |\r\n| createdByUserId | CostCentre->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentre->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentre->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentre->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostCentre->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentre->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentre->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentre->ModifiedOn | string | date-time |\r\n| version | CostCentre->Version | integer | int32 |\r\n| permissionTreeId | CostCentre->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentre->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentre->PermissionTree_Description | string | |\r\n| id | CostCentre->Id | integer | int64 |\r\n| costCentreTypeId | CostCentre->CostCentreType_Id | integer | int64 |\r\n| costCentreTypeCode | CostCentre->CostCentreType_Code | string | |\r\n| costCentreTypeDescription | CostCentre->CostCentreType_Description | string | |\r\n| description | CostCentre->Description | string | |\r\n| notes | CostCentre->Notes | string | |\r\n| sequenceNumber | CostCentre->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCostCentre", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre", "schema": { "$ref": "#/definitions/GetCostCentreResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre" ], "summary": "Update an existing Cost Centre resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentre->Version | integer | int32 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n| sequenceNumber | CostCentre->SequenceNumber | integer | int32 |\r\n| costCentreTypeId | CostCentre->CostCentreType_Id | integer | int64 |\r\n| notes | CostCentre->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| costCentreTypeId | Nullable | False | |\r\n\r\n", "operationId": "UpdateCostCentre", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCostCentreResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre" ], "summary": "Delete an existing Cost Centre resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentre->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCostCentre", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCostCentreResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres": { "get": { "tags": [ "Cost Centre" ], "summary": "Get a collection of Cost Centre resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentre->Version | integer | int32 |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n| sequenceNumber | CostCentre->SequenceNumber | integer | int32 |\r\n| costCentreTypeId | CostCentre->CostCentreType_Id | integer | int64 |\r\n| costCentreTypeCode | CostCentre->CostCentreType_Code | string | |\r\n| costCentreTypeDescription | CostCentre->CostCentreType_Description | string | |\r\n| notes | CostCentre->Notes | string | |\r\n| createdOn | CostCentre->CreatedOn | string | date-time |\r\n| modifiedOn | CostCentre->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostCentreCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/GetCostCentreCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Cost Centre" ], "summary": "Create a new Cost Centre resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | CostCentre->PermissionTree_Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n| sequenceNumber | CostCentre->SequenceNumber | integer | int32 |\r\n| costCentreTypeId | CostCentre->CostCentreType_Id | integer | int64 |\r\n| notes | CostCentre->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| costCentreTypeId | Required | True | |\r\n| costCentreTypeId | Nullable | False | |\r\n\r\n", "operationId": "CreateCostCentre", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostCentreResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Lookups/LookupCostCentreChangePermissionTree": { "get": { "tags": [ "Cost Centre" ], "summary": "Lookup the permission set for changing the Cost Centre.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostCentreChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostCentreChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Lookups/LookupCostCentreCostCentreType": { "get": { "tags": [ "Cost Centre" ], "summary": "Lookup the Cost Centre Type for the Cost Centre.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| code | CostCentreType->Code | string | |\r\n| description | CostCentreType->Description | string | |\r\n", "operationId": "LookupCostCentreCostCentreType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre Type collection", "schema": { "$ref": "#/definitions/CostCentreCostCentreTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Lookups/LookupCostCentreInsertPermissionTree": { "get": { "tags": [ "Cost Centre" ], "summary": "Lookup the permission set for creating the Cost Centre.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostCentreInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostCentreInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Batch/{ids}": { "get": { "tags": [ "Cost Centre" ], "summary": "Get a collection of Cost Centre resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | CostCentre->Code | string | |\r\n| isActive | CostCentre->IsActive | boolean | |\r\n| createdByUserId | CostCentre->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentre->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentre->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentre->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostCentre->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentre->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentre->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentre->ModifiedOn | string | date-time |\r\n| version | CostCentre->Version | integer | int32 |\r\n| permissionTreeId | CostCentre->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentre->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentre->PermissionTree_Description | string | |\r\n| id | CostCentre->Id | integer | int64 |\r\n| costCentreTypeId | CostCentre->CostCentreType_Id | integer | int64 |\r\n| costCentreTypeCode | CostCentre->CostCentreType_Code | string | |\r\n| costCentreTypeDescription | CostCentre->CostCentreType_Description | string | |\r\n| description | CostCentre->Description | string | |\r\n| notes | CostCentre->Notes | string | |\r\n| sequenceNumber | CostCentre->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCostCentre", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Cost Centre id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre collection", "schema": { "$ref": "#/definitions/BatchGetCostCentreResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Batch": { "post": { "tags": [ "Cost Centre" ], "summary": "Create a new collection of Cost Centre resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | CostCentre->PermissionTree_Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n| sequenceNumber | CostCentre->SequenceNumber | integer | int32 |\r\n| costCentreTypeId | CostCentre->CostCentreType_Id | integer | int64 |\r\n| notes | CostCentre->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| costCentreTypeId | Required | True | |\r\n| costCentreTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCostCentre", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostCentreResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Cost Centre batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre" ], "summary": "Update a collection of existing Cost Centre resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| version | CostCentre->Version | integer | int32 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n| sequenceNumber | CostCentre->SequenceNumber | integer | int32 |\r\n| costCentreTypeId | CostCentre->CostCentreType_Id | integer | int64 |\r\n| notes | CostCentre->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| costCentreTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateCostCentre", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCostCentreResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre" ], "summary": "Delete a collection of existing Cost Centre resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| version | CostCentre->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCostCentre", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCostCentreResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/{id}/Active": { "patch": { "tags": [ "Cost Centre" ], "summary": "Change the IsActive status for an existing Cost Centre resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentre->Version | integer | int32 |\r\n| isActive | CostCentre->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostCentreIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostCentreIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/{id}/PermissionTree": { "patch": { "tags": [ "Cost Centre" ], "summary": "Change the PermissionTree for an existing Cost Centre resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentre->Version | integer | int32 |\r\n| permissionTreeId | CostCentre->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostCentrePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostCentrePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Batch/Active": { "patch": { "tags": [ "Cost Centre" ], "summary": "Change the IsActive status for a collection of existing Cost Centre resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| version | CostCentre->Version | integer | int32 |\r\n| isActive | CostCentre->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostCentreIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostCentreIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Batch/PermissionTree": { "patch": { "tags": [ "Cost Centre" ], "summary": "Change the PermissionTree status for a collection of existing Cost Centre resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| version | CostCentre->Version | integer | int32 |\r\n| permissionTreeId | CostCentre->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostCentrePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostCentrePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/{id}": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Get a Cost Centre Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreAttribute->CostCentre_Id | integer | int64 |\r\n| costCentreCode | CostCentreAttribute->CostCentre_Code | string | |\r\n| costCentreDescription | CostCentreAttribute->CostCentre_Description | string | |\r\n| createdByUserId | CostCentreAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentreAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentreAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentreAttribute->CreatedOn | string | date-time |\r\n| isActive | CostCentreAttribute->IsActive | boolean | |\r\n| modifiedByUserId | CostCentreAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentreAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentreAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentreAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostCentreAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentreAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentreAttribute->PermissionTree_Description | string | |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| id | CostCentreAttribute->Id | integer | int64 |\r\n| attributeId | CostCentreAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostCentreAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostCentreAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | CostCentreAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | CostCentreAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | CostCentreAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | CostCentreAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | CostCentreAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | CostCentreAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostCentreAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostCentreAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n", "operationId": "GetCostCentreAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre Attribute", "schema": { "$ref": "#/definitions/GetCostCentreAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre Attribute" ], "summary": "Update an existing Cost Centre Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateCostCentreAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCostCentreAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre Attribute" ], "summary": "Delete an existing Cost Centre Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCostCentreAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCostCentreAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/{costCentreId}/Attributes": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Get a collection of Cost Centre Attribute resources for the Cost Centre.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreAttribute->Id | integer | int64 |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | CostCentreAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostCentreAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostCentreAttribute->Attribute_Description | string | |\r\n| attributeDataType | CostCentreAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostCentreAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostCentreAttribute->PredefinedValue_Value | object | composite |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n| createdOn | CostCentreAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | CostCentreAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostCentreAttributeCollectionForCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "costCentreId", "in": "path", "required": true, "description": "Cost Centre Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre Attribute collection", "schema": { "$ref": "#/definitions/GetCostCentreAttributeCollectionForCostCentreResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Get a collection of Cost Centre Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreAttribute->Id | integer | int64 |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| costCentreCode | CostCentreAttribute->CostCentre_Code | string | |\r\n| costCentreDescription | CostCentreAttribute->CostCentre_Description | string | |\r\n| attributeId | CostCentreAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostCentreAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostCentreAttribute->Attribute_Description | string | |\r\n| attributeDataType | CostCentreAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostCentreAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostCentreAttribute->PredefinedValue_Value | object | composite |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n| createdOn | CostCentreAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | CostCentreAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostCentreAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre Attribute collection", "schema": { "$ref": "#/definitions/GetCostCentreAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Cost Centre Attribute" ], "summary": "Create a new Cost Centre Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreAttribute->CostCentre_Id | integer | int64 |\r\n| attributeId | CostCentreAttribute->Attribute_Id | integer | int64 |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | CostCentreAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateCostCentreAttribute", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostCentreAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/Lookups/LookupCostCentreAttributeAllowedValue": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Cost Centre Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupCostCentreAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/CostCentreAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/Lookups/LookupCostCentreAttribute": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Lookup the Attribute for the Cost Centre Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupCostCentreAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/CostCentreAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/Lookups/LookupCostCentreAttributeCostCentre": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Lookup the Cost Centre Attribute for the Cost Centre Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupCostCentreAttributeCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/CostCentreAttributeCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/Lookups/LookupCostCentreAttributeInsertPermissionTree": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Lookup the permission set for creating the Cost Centre Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostCentreAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostCentreAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/Batch/{ids}": { "get": { "tags": [ "Cost Centre Attribute" ], "summary": "Get a collection of Cost Centre Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreAttribute->CostCentre_Id | integer | int64 |\r\n| costCentreCode | CostCentreAttribute->CostCentre_Code | string | |\r\n| costCentreDescription | CostCentreAttribute->CostCentre_Description | string | |\r\n| createdByUserId | CostCentreAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentreAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentreAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentreAttribute->CreatedOn | string | date-time |\r\n| isActive | CostCentreAttribute->IsActive | boolean | |\r\n| modifiedByUserId | CostCentreAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentreAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentreAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentreAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostCentreAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentreAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentreAttribute->PermissionTree_Description | string | |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| id | CostCentreAttribute->Id | integer | int64 |\r\n| attributeId | CostCentreAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostCentreAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostCentreAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | CostCentreAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | CostCentreAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | CostCentreAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | CostCentreAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | CostCentreAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | CostCentreAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostCentreAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostCentreAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n", "operationId": "BatchGetCostCentreAttribute", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Cost Centre Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre Attribute collection", "schema": { "$ref": "#/definitions/BatchGetCostCentreAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/Batch": { "post": { "tags": [ "Cost Centre Attribute" ], "summary": "Create a new collection of Cost Centre Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreAttribute->CostCentre_Id | integer | int64 |\r\n| attributeId | CostCentreAttribute->Attribute_Id | integer | int64 |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | CostCentreAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCostCentreAttribute", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostCentreAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Cost Centre Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre Attribute" ], "summary": "Update a collection of existing Cost Centre Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreAttribute->Id | integer | int64 |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| value | CostCentreAttribute->Value | object | composite |\r\n| predefinedValueId | CostCentreAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | CostCentreAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostCentreAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateCostCentreAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCostCentreAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre Attribute" ], "summary": "Delete a collection of existing Cost Centre Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreAttribute->Id | integer | int64 |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCostCentreAttribute", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCostCentreAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/{id}/Active": { "patch": { "tags": [ "Cost Centre Attribute" ], "summary": "Change the IsActive status for an existing Cost Centre Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| isActive | CostCentreAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostCentreAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostCentreAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Attributes/Batch/Active": { "patch": { "tags": [ "Cost Centre Attribute" ], "summary": "Change the IsActive status for a collection of existing Cost Centre Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreAttribute->Id | integer | int64 |\r\n| version | CostCentreAttribute->Version | integer | int32 |\r\n| isActive | CostCentreAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostCentreAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostCentreAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/{id}": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Get a Cost Centre Document resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreDocument->CostCentre_Id | integer | int64 |\r\n| costCentreCode | CostCentreDocument->CostCentre_Code | string | |\r\n| costCentreDescription | CostCentreDocument->CostCentre_Description | string | |\r\n| isActive | CostCentreDocument->IsActive | boolean | |\r\n| createdByUserId | CostCentreDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentreDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentreDocument->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentreDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostCentreDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentreDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentreDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentreDocument->ModifiedOn | string | date-time |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| permissionTreeId | CostCentreDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentreDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentreDocument->PermissionTree_Description | string | |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| documentRecordId | CostCentreDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostCentreDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostCentreDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostCentreDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | CostCentreDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | CostCentreDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | CostCentreDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | CostCentreDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | CostCentreDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | CostCentreDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | CostCentreDocument->Notes | string | |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCostCentreDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre Document", "schema": { "$ref": "#/definitions/GetCostCentreDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre Document" ], "summary": "Update an existing Cost Centre Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n| notes | CostCentreDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateCostCentreDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCostCentreDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre Document" ], "summary": "Delete an existing Cost Centre Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCostCentreDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCostCentreDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Document was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/{id}/Documents": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Get a collection of Cost Centre Document resources for the Cost Centre.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | CostCentreDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostCentreDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostCentreDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostCentreDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | CostCentreDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | CostCentreDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | CostCentreDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetCostCentreDocumentCollectionForCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre Document collection", "schema": { "$ref": "#/definitions/GetCostCentreDocumentCollectionForCostCentreResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Get a collection of Cost Centre Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| costCentreId | CostCentreDocument->CostCentre_Id | integer | int64 |\r\n| costCentreCode | CostCentreDocument->CostCentre_Code | string | |\r\n| costCentreDescription | CostCentreDocument->CostCentre_Description | string | |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | CostCentreDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostCentreDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostCentreDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostCentreDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | CostCentreDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | CostCentreDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | CostCentreDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetCostCentreDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre Document collection", "schema": { "$ref": "#/definitions/GetCostCentreDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Cost Centre Document" ], "summary": "Create a new Cost Centre Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreDocument->CostCentre_Id | integer | int64 |\r\n| documentRecordId | CostCentreDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | CostCentreDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n| notes | CostCentreDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateCostCentreDocument", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostCentreDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Lookups/LookupCostCentreDocumentChangePermissionTree": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Lookup the permission set for changing the Cost Centre Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostCentreDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostCentreDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Lookups/LookupCostCentreDocumentCostCentre": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Lookup the Cost Centre Document for the Cost Centre Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupCostCentreDocumentCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/CostCentreDocumentCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Lookups/LookupCostCentreDocument": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Cost Centre Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupCostCentreDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/CostCentreDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Lookups/LookupCostCentreDocumentInsertPermissionTree": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Lookup the permission set for creating the Cost Centre Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostCentreDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostCentreDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Batch/{ids}": { "get": { "tags": [ "Cost Centre Document" ], "summary": "Get a collection of Cost Centre Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreDocument->CostCentre_Id | integer | int64 |\r\n| costCentreCode | CostCentreDocument->CostCentre_Code | string | |\r\n| costCentreDescription | CostCentreDocument->CostCentre_Description | string | |\r\n| isActive | CostCentreDocument->IsActive | boolean | |\r\n| createdByUserId | CostCentreDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentreDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentreDocument->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentreDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostCentreDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentreDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentreDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentreDocument->ModifiedOn | string | date-time |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| permissionTreeId | CostCentreDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentreDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentreDocument->PermissionTree_Description | string | |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| documentRecordId | CostCentreDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostCentreDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostCentreDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostCentreDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | CostCentreDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | CostCentreDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | CostCentreDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | CostCentreDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | CostCentreDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | CostCentreDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | CostCentreDocument->Notes | string | |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCostCentreDocument", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Cost Centre Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre Document collection", "schema": { "$ref": "#/definitions/BatchGetCostCentreDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Batch": { "post": { "tags": [ "Cost Centre Document" ], "summary": "Create a new collection of Cost Centre Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costCentreId | CostCentreDocument->CostCentre_Id | integer | int64 |\r\n| documentRecordId | CostCentreDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | CostCentreDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n| notes | CostCentreDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCostCentreDocument", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostCentreDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Cost Centre Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre Document" ], "summary": "Update a collection of existing Cost Centre Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| sequenceNumber | CostCentreDocument->SequenceNumber | integer | int32 |\r\n| notes | CostCentreDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateCostCentreDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCostCentreDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre Document" ], "summary": "Delete a collection of existing Cost Centre Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCostCentreDocument", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCostCentreDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Document batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/{id}/Active": { "patch": { "tags": [ "Cost Centre Document" ], "summary": "Change the IsActive status for an existing Cost Centre Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| isActive | CostCentreDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostCentreDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostCentreDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Cost Centre Document" ], "summary": "Change the PermissionTree for an existing Cost Centre Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| permissionTreeId | CostCentreDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostCentreDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostCentreDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Cost Centre Document" ], "summary": "Change the PermissionTree status for a collection of existing Cost Centre Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| permissionTreeId | CostCentreDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostCentreDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostCentreDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentres/Documents/Batch/Active": { "patch": { "tags": [ "Cost Centre Document" ], "summary": "Change the IsActive status for a collection of existing Cost Centre Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreDocument->Id | integer | int64 |\r\n| version | CostCentreDocument->Version | integer | int32 |\r\n| isActive | CostCentreDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostCentreDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostCentreDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/{id}": { "get": { "tags": [ "Cost Centre Type" ], "summary": "Get a Cost Centre Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | CostCentreType->Code | string | |\r\n| createdByUserId | CostCentreType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentreType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentreType->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentreType->CreatedOn | string | date-time |\r\n| isActive | CostCentreType->IsActive | boolean | |\r\n| modifiedByUserId | CostCentreType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentreType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentreType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentreType->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostCentreType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentreType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentreType->PermissionTree_Description | string | |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| description | CostCentreType->Description | string | |\r\n| notes | CostCentreType->Notes | string | |\r\n| sequenceNumber | CostCentreType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCostCentreType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre Type", "schema": { "$ref": "#/definitions/GetCostCentreTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre Type" ], "summary": "Update an existing Cost Centre Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| code | CostCentreType->Code | string | |\r\n| description | CostCentreType->Description | string | |\r\n| sequenceNumber | CostCentreType->SequenceNumber | integer | int32 |\r\n| notes | CostCentreType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateCostCentreType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCostCentreTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre Type" ], "summary": "Delete an existing Cost Centre Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCostCentreType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCostCentreTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes": { "get": { "tags": [ "Cost Centre Type" ], "summary": "Get a collection of Cost Centre Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| code | CostCentreType->Code | string | |\r\n| description | CostCentreType->Description | string | |\r\n| sequenceNumber | CostCentreType->SequenceNumber | integer | int32 |\r\n| notes | CostCentreType->Notes | string | |\r\n| createdOn | CostCentreType->CreatedOn | string | date-time |\r\n| modifiedOn | CostCentreType->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostCentreTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre Type collection", "schema": { "$ref": "#/definitions/GetCostCentreTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Cost Centre Type" ], "summary": "Create a new Cost Centre Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | CostCentreType->PermissionTree_Id | integer | int64 |\r\n| code | CostCentreType->Code | string | |\r\n| description | CostCentreType->Description | string | |\r\n| sequenceNumber | CostCentreType->SequenceNumber | integer | int32 |\r\n| notes | CostCentreType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateCostCentreType", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostCentreTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/Lookups/LookupCostCentreTypeChangePermissionTree": { "get": { "tags": [ "Cost Centre Type" ], "summary": "Lookup the permission set for changing the Cost Centre Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostCentreTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostCentreTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/Lookups/LookupCostCentreTypeInsertPermissionTree": { "get": { "tags": [ "Cost Centre Type" ], "summary": "Lookup the permission set for creating the Cost Centre Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostCentreTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostCentreTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/Batch/{ids}": { "get": { "tags": [ "Cost Centre Type" ], "summary": "Get a collection of Cost Centre Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | CostCentreType->Code | string | |\r\n| createdByUserId | CostCentreType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostCentreType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostCentreType->CreatedByUser_FullName | string | |\r\n| createdOn | CostCentreType->CreatedOn | string | date-time |\r\n| isActive | CostCentreType->IsActive | boolean | |\r\n| modifiedByUserId | CostCentreType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostCentreType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostCentreType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostCentreType->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostCentreType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostCentreType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostCentreType->PermissionTree_Description | string | |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| description | CostCentreType->Description | string | |\r\n| notes | CostCentreType->Notes | string | |\r\n| sequenceNumber | CostCentreType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCostCentreType", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Cost Centre Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Centre Type collection", "schema": { "$ref": "#/definitions/BatchGetCostCentreTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/Batch": { "post": { "tags": [ "Cost Centre Type" ], "summary": "Create a new collection of Cost Centre Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | CostCentreType->PermissionTree_Id | integer | int64 |\r\n| code | CostCentreType->Code | string | |\r\n| description | CostCentreType->Description | string | |\r\n| sequenceNumber | CostCentreType->SequenceNumber | integer | int32 |\r\n| notes | CostCentreType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateCostCentreType", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostCentreTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Cost Centre Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Centre Type" ], "summary": "Update a collection of existing Cost Centre Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| code | CostCentreType->Code | string | |\r\n| description | CostCentreType->Description | string | |\r\n| sequenceNumber | CostCentreType->SequenceNumber | integer | int32 |\r\n| notes | CostCentreType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateCostCentreType", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCostCentreTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Centre Type" ], "summary": "Delete a collection of existing Cost Centre Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| version | CostCentreType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCostCentreType", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCostCentreTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Centre Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/{id}/Active": { "patch": { "tags": [ "Cost Centre Type" ], "summary": "Change the IsActive status for an existing Cost Centre Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| isActive | CostCentreType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostCentreTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostCentreTypeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/{id}/PermissionTree": { "patch": { "tags": [ "Cost Centre Type" ], "summary": "Change the PermissionTree for an existing Cost Centre Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| permissionTreeId | CostCentreType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostCentreTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Centre Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostCentreTypePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/Batch/Active": { "patch": { "tags": [ "Cost Centre Type" ], "summary": "Change the IsActive status for a collection of existing Cost Centre Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| isActive | CostCentreType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostCentreTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostCentreTypeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostCentreTypes/Batch/PermissionTree": { "patch": { "tags": [ "Cost Centre Type" ], "summary": "Change the PermissionTree status for a collection of existing Cost Centre Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentreType->Id | integer | int64 |\r\n| version | CostCentreType->Version | integer | int32 |\r\n| permissionTreeId | CostCentreType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostCentreTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostCentreTypePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/{id}": { "get": { "tags": [ "Cost Element" ], "summary": "Get a Cost Element resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | CostElement->Code | string | |\r\n| createdByUserId | CostElement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostElement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostElement->CreatedByUser_FullName | string | |\r\n| createdOn | CostElement->CreatedOn | string | date-time |\r\n| isActive | CostElement->IsActive | boolean | |\r\n| modifiedByUserId | CostElement->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostElement->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostElement->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostElement->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostElement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostElement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostElement->PermissionTree_Description | string | |\r\n| version | CostElement->Version | integer | int32 |\r\n| id | CostElement->Id | integer | int64 |\r\n| description | CostElement->Description | string | |\r\n| notes | CostElement->Notes | string | |\r\n| sequenceNumber | CostElement->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCostElement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Element", "schema": { "$ref": "#/definitions/GetCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Element" ], "summary": "Update an existing Cost Element resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElement->Version | integer | int32 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n| sequenceNumber | CostElement->SequenceNumber | integer | int32 |\r\n| notes | CostElement->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateCostElement", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCostElementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Element" ], "summary": "Delete an existing Cost Element resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElement->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCostElement", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCostElementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements": { "get": { "tags": [ "Cost Element" ], "summary": "Get a collection of Cost Element resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElement->Version | integer | int32 |\r\n| id | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n| sequenceNumber | CostElement->SequenceNumber | integer | int32 |\r\n| notes | CostElement->Notes | string | |\r\n| createdOn | CostElement->CreatedOn | string | date-time |\r\n| modifiedOn | CostElement->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostElementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element collection", "schema": { "$ref": "#/definitions/GetCostElementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Cost Element" ], "summary": "Create a new Cost Element resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | CostElement->PermissionTree_Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n| sequenceNumber | CostElement->SequenceNumber | integer | int32 |\r\n| notes | CostElement->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateCostElement", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostElementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Lookups/LookupCostElementChangePermissionTree": { "get": { "tags": [ "Cost Element" ], "summary": "Lookup the permission set for changing the Cost Element.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostElementChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostElementChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Lookups/LookupCostElementInsertPermissionTree": { "get": { "tags": [ "Cost Element" ], "summary": "Lookup the permission set for creating the Cost Element.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostElementInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostElementInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Batch/{ids}": { "get": { "tags": [ "Cost Element" ], "summary": "Get a collection of Cost Element resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | CostElement->Code | string | |\r\n| createdByUserId | CostElement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostElement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostElement->CreatedByUser_FullName | string | |\r\n| createdOn | CostElement->CreatedOn | string | date-time |\r\n| isActive | CostElement->IsActive | boolean | |\r\n| modifiedByUserId | CostElement->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostElement->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostElement->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostElement->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostElement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostElement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostElement->PermissionTree_Description | string | |\r\n| version | CostElement->Version | integer | int32 |\r\n| id | CostElement->Id | integer | int64 |\r\n| description | CostElement->Description | string | |\r\n| notes | CostElement->Notes | string | |\r\n| sequenceNumber | CostElement->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCostElement", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Cost Element id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Element collection", "schema": { "$ref": "#/definitions/BatchGetCostElementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Batch": { "post": { "tags": [ "Cost Element" ], "summary": "Create a new collection of Cost Element resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | CostElement->PermissionTree_Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n| sequenceNumber | CostElement->SequenceNumber | integer | int32 |\r\n| notes | CostElement->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateCostElement", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostElementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Cost Element batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Element" ], "summary": "Update a collection of existing Cost Element resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| version | CostElement->Version | integer | int32 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n| sequenceNumber | CostElement->SequenceNumber | integer | int32 |\r\n| notes | CostElement->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateCostElement", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCostElementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Element" ], "summary": "Delete a collection of existing Cost Element resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| version | CostElement->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCostElement", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCostElementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/{id}/Active": { "patch": { "tags": [ "Cost Element" ], "summary": "Change the IsActive status for an existing Cost Element resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElement->Version | integer | int32 |\r\n| isActive | CostElement->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostElementIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostElementIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/{id}/PermissionTree": { "patch": { "tags": [ "Cost Element" ], "summary": "Change the PermissionTree for an existing Cost Element resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElement->Version | integer | int32 |\r\n| permissionTreeId | CostElement->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostElementPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostElementPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Batch/Active": { "patch": { "tags": [ "Cost Element" ], "summary": "Change the IsActive status for a collection of existing Cost Element resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| version | CostElement->Version | integer | int32 |\r\n| isActive | CostElement->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostElementIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostElementIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Batch/PermissionTree": { "patch": { "tags": [ "Cost Element" ], "summary": "Change the PermissionTree status for a collection of existing Cost Element resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| version | CostElement->Version | integer | int32 |\r\n| permissionTreeId | CostElement->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostElementPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostElementPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/{id}": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Get a Cost Element Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementAttribute->CostElement_Id | integer | int64 |\r\n| costElementCode | CostElementAttribute->CostElement_Code | string | |\r\n| costElementDescription | CostElementAttribute->CostElement_Description | string | |\r\n| createdByUserId | CostElementAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostElementAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostElementAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | CostElementAttribute->CreatedOn | string | date-time |\r\n| isActive | CostElementAttribute->IsActive | boolean | |\r\n| modifiedByUserId | CostElementAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostElementAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostElementAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostElementAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostElementAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostElementAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostElementAttribute->PermissionTree_Description | string | |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| id | CostElementAttribute->Id | integer | int64 |\r\n| attributeId | CostElementAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostElementAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostElementAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | CostElementAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | CostElementAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | CostElementAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | CostElementAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | CostElementAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | CostElementAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | CostElementAttribute->Notes | string | |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostElementAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostElementAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| value | CostElementAttribute->Value | object | composite |\r\n", "operationId": "GetCostElementAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Element Attribute", "schema": { "$ref": "#/definitions/GetCostElementAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Element Attribute" ], "summary": "Update an existing Cost Element Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| value | CostElementAttribute->Value | object | composite |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostElementAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateCostElementAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCostElementAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Element Attribute" ], "summary": "Delete an existing Cost Element Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCostElementAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCostElementAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/{costElementId}/Attributes": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Get a collection of Cost Element Attribute resources for the Cost Element.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementAttribute->Id | integer | int64 |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | CostElementAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostElementAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostElementAttribute->Attribute_Description | string | |\r\n| attributeDataType | CostElementAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostElementAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostElementAttribute->PredefinedValue_Value | object | composite |\r\n| value | CostElementAttribute->Value | object | composite |\r\n| notes | CostElementAttribute->Notes | string | |\r\n| createdOn | CostElementAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | CostElementAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostElementAttributeCollectionForCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "costElementId", "in": "path", "required": true, "description": "Cost Element Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element Attribute collection", "schema": { "$ref": "#/definitions/GetCostElementAttributeCollectionForCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Get a collection of Cost Element Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementAttribute->Id | integer | int64 |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| costElementCode | CostElementAttribute->CostElement_Code | string | |\r\n| costElementDescription | CostElementAttribute->CostElement_Description | string | |\r\n| attributeId | CostElementAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostElementAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostElementAttribute->Attribute_Description | string | |\r\n| attributeDataType | CostElementAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostElementAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostElementAttribute->PredefinedValue_Value | object | composite |\r\n| value | CostElementAttribute->Value | object | composite |\r\n| notes | CostElementAttribute->Notes | string | |\r\n| createdOn | CostElementAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | CostElementAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostElementAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element Attribute collection", "schema": { "$ref": "#/definitions/GetCostElementAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Cost Element Attribute" ], "summary": "Create a new Cost Element Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementAttribute->CostElement_Id | integer | int64 |\r\n| attributeId | CostElementAttribute->Attribute_Id | integer | int64 |\r\n| value | CostElementAttribute->Value | object | composite |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | CostElementAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostElementAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateCostElementAttribute", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostElementAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/Lookups/LookupCostElementAttributeAllowedValue": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Cost Element Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupCostElementAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/CostElementAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/Lookups/LookupCostElementAttribute": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Lookup the Attribute for the Cost Element Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupCostElementAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/CostElementAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/Lookups/LookupCostElementAttributeCostElement": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Lookup the Cost Element Attribute for the Cost Element Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupCostElementAttributeCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element collection", "schema": { "$ref": "#/definitions/CostElementAttributeCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/Lookups/LookupCostElementAttributeInsertPermissionTree": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Lookup the permission set for creating the Cost Element Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostElementAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostElementAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/Batch/{ids}": { "get": { "tags": [ "Cost Element Attribute" ], "summary": "Get a collection of Cost Element Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementAttribute->CostElement_Id | integer | int64 |\r\n| costElementCode | CostElementAttribute->CostElement_Code | string | |\r\n| costElementDescription | CostElementAttribute->CostElement_Description | string | |\r\n| createdByUserId | CostElementAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostElementAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostElementAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | CostElementAttribute->CreatedOn | string | date-time |\r\n| isActive | CostElementAttribute->IsActive | boolean | |\r\n| modifiedByUserId | CostElementAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostElementAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostElementAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostElementAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | CostElementAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostElementAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostElementAttribute->PermissionTree_Description | string | |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| id | CostElementAttribute->Id | integer | int64 |\r\n| attributeId | CostElementAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | CostElementAttribute->Attribute_Code | string | |\r\n| attributeDescription | CostElementAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | CostElementAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | CostElementAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | CostElementAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | CostElementAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | CostElementAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | CostElementAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | CostElementAttribute->Notes | string | |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | CostElementAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | CostElementAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| value | CostElementAttribute->Value | object | composite |\r\n", "operationId": "BatchGetCostElementAttribute", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Cost Element Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Element Attribute collection", "schema": { "$ref": "#/definitions/BatchGetCostElementAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/Batch": { "post": { "tags": [ "Cost Element Attribute" ], "summary": "Create a new collection of Cost Element Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementAttribute->CostElement_Id | integer | int64 |\r\n| attributeId | CostElementAttribute->Attribute_Id | integer | int64 |\r\n| value | CostElementAttribute->Value | object | composite |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | CostElementAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostElementAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCostElementAttribute", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostElementAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Cost Element Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Element Attribute" ], "summary": "Update a collection of existing Cost Element Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementAttribute->Id | integer | int64 |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| value | CostElementAttribute->Value | object | composite |\r\n| predefinedValueId | CostElementAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | CostElementAttribute->SequenceNumber | integer | int32 |\r\n| notes | CostElementAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateCostElementAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCostElementAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Element Attribute" ], "summary": "Delete a collection of existing Cost Element Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementAttribute->Id | integer | int64 |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCostElementAttribute", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCostElementAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/{id}/Active": { "patch": { "tags": [ "Cost Element Attribute" ], "summary": "Change the IsActive status for an existing Cost Element Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| isActive | CostElementAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostElementAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostElementAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Attributes/Batch/Active": { "patch": { "tags": [ "Cost Element Attribute" ], "summary": "Change the IsActive status for a collection of existing Cost Element Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementAttribute->Id | integer | int64 |\r\n| version | CostElementAttribute->Version | integer | int32 |\r\n| isActive | CostElementAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostElementAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostElementAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/{id}": { "get": { "tags": [ "Cost Element Document" ], "summary": "Get a Cost Element Document resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementDocument->CostElement_Id | integer | int64 |\r\n| costElementCode | CostElementDocument->CostElement_Code | string | |\r\n| costElementDescription | CostElementDocument->CostElement_Description | string | |\r\n| isActive | CostElementDocument->IsActive | boolean | |\r\n| createdByUserId | CostElementDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostElementDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostElementDocument->CreatedByUser_FullName | string | |\r\n| createdOn | CostElementDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostElementDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostElementDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostElementDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostElementDocument->ModifiedOn | string | date-time |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| permissionTreeId | CostElementDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostElementDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostElementDocument->PermissionTree_Description | string | |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| documentRecordId | CostElementDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostElementDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostElementDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostElementDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | CostElementDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | CostElementDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | CostElementDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | CostElementDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | CostElementDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | CostElementDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | CostElementDocument->Notes | string | |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCostElementDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Element Document", "schema": { "$ref": "#/definitions/GetCostElementDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Element Document" ], "summary": "Update an existing Cost Element Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n| notes | CostElementDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateCostElementDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCostElementDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Element Document" ], "summary": "Delete an existing Cost Element Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCostElementDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCostElementDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Document was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/{id}/Documents": { "get": { "tags": [ "Cost Element Document" ], "summary": "Get a collection of Cost Element Document resources for the Cost Element.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | CostElementDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostElementDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostElementDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostElementDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | CostElementDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | CostElementDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | CostElementDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetCostElementDocumentCollectionForCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element Document collection", "schema": { "$ref": "#/definitions/GetCostElementDocumentCollectionForCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents": { "get": { "tags": [ "Cost Element Document" ], "summary": "Get a collection of Cost Element Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| costElementId | CostElementDocument->CostElement_Id | integer | int64 |\r\n| costElementCode | CostElementDocument->CostElement_Code | string | |\r\n| costElementDescription | CostElementDocument->CostElement_Description | string | |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | CostElementDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostElementDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostElementDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostElementDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | CostElementDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | CostElementDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | CostElementDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetCostElementDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element Document collection", "schema": { "$ref": "#/definitions/GetCostElementDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Cost Element Document" ], "summary": "Create a new Cost Element Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementDocument->CostElement_Id | integer | int64 |\r\n| documentRecordId | CostElementDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | CostElementDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n| notes | CostElementDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateCostElementDocument", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostElementDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Lookups/LookupCostElementDocumentChangePermissionTree": { "get": { "tags": [ "Cost Element Document" ], "summary": "Lookup the permission set for changing the Cost Element Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostElementDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostElementDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Lookups/LookupCostElementDocumentCostElement": { "get": { "tags": [ "Cost Element Document" ], "summary": "Lookup the Cost Element Document for the Cost Element Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupCostElementDocumentCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element collection", "schema": { "$ref": "#/definitions/CostElementDocumentCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Lookups/LookupCostElementDocument": { "get": { "tags": [ "Cost Element Document" ], "summary": "Cost Element Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupCostElementDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/CostElementDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Lookups/LookupCostElementDocumentInsertPermissionTree": { "get": { "tags": [ "Cost Element Document" ], "summary": "Lookup the permission set for creating the Cost Element Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostElementDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostElementDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Batch/{ids}": { "get": { "tags": [ "Cost Element Document" ], "summary": "Get a collection of Cost Element Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementDocument->CostElement_Id | integer | int64 |\r\n| costElementCode | CostElementDocument->CostElement_Code | string | |\r\n| costElementDescription | CostElementDocument->CostElement_Description | string | |\r\n| isActive | CostElementDocument->IsActive | boolean | |\r\n| createdByUserId | CostElementDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostElementDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostElementDocument->CreatedByUser_FullName | string | |\r\n| createdOn | CostElementDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostElementDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostElementDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostElementDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostElementDocument->ModifiedOn | string | date-time |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| permissionTreeId | CostElementDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostElementDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostElementDocument->PermissionTree_Description | string | |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| documentRecordId | CostElementDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | CostElementDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | CostElementDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | CostElementDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | CostElementDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | CostElementDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | CostElementDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | CostElementDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | CostElementDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | CostElementDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | CostElementDocument->Notes | string | |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCostElementDocument", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Cost Element Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Cost Element Document collection", "schema": { "$ref": "#/definitions/BatchGetCostElementDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Batch": { "post": { "tags": [ "Cost Element Document" ], "summary": "Create a new collection of Cost Element Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| costElementId | CostElementDocument->CostElement_Id | integer | int64 |\r\n| documentRecordId | CostElementDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | CostElementDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n| notes | CostElementDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCostElementDocument", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostElementDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Cost Element Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Cost Element Document" ], "summary": "Update a collection of existing Cost Element Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| sequenceNumber | CostElementDocument->SequenceNumber | integer | int32 |\r\n| notes | CostElementDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateCostElementDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCostElementDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Cost Element Document" ], "summary": "Delete a collection of existing Cost Element Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCostElementDocument", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCostElementDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Cost Element Document batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/{id}/Active": { "patch": { "tags": [ "Cost Element Document" ], "summary": "Change the IsActive status for an existing Cost Element Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| isActive | CostElementDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostElementDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostElementDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Cost Element Document" ], "summary": "Change the PermissionTree for an existing Cost Element Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| permissionTreeId | CostElementDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeCostElementDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Cost Element Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCostElementDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Cost Element Document" ], "summary": "Change the PermissionTree status for a collection of existing Cost Element Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| permissionTreeId | CostElementDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostElementDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostElementDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/CostElements/Documents/Batch/Active": { "patch": { "tags": [ "Cost Element Document" ], "summary": "Change the IsActive status for a collection of existing Cost Element Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElementDocument->Id | integer | int64 |\r\n| version | CostElementDocument->Version | integer | int32 |\r\n| isActive | CostElementDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCostElementDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCostElementDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/{id}": { "get": { "tags": [ "Costing" ], "summary": "Get a Costing resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | Costing->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Costing->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Costing->CreatedByUser_FullName | string | |\r\n| createdOn | Costing->CreatedOn | string | date-time |\r\n| modifiedByUserId | Costing->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Costing->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Costing->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Costing->ModifiedOn | string | date-time |\r\n| version | Costing->Version | integer | int32 |\r\n| permissionTreeId | Costing->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Costing->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Costing->PermissionTree_Description | string | |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n| id | Costing->Id | integer | int64 |\r\n| assetId | Costing->Asset_Id | integer | int64 |\r\n| assetCode | Costing->Asset_Code | string | |\r\n| assetDescription | Costing->Asset_Description | string | |\r\n| assetRecordType | Costing->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetConsumptionId | Costing->AssetConsumption_Id | integer | int64 |\r\n| assetConsumptionAssetId | Costing->AssetConsumption_Asset_Id | integer | int64 |\r\n| assetConsumptionAssetCode | Costing->AssetConsumption_Asset_Code | string | |\r\n| assetConsumptionAssetDescription | Costing->AssetConsumption_Asset_Description | string | |\r\n| assetConsumptionAssetIsMsi | Costing->AssetConsumption_Asset_IsMsi | boolean | |\r\n| assetConsumptionAssetRecordType | Costing->AssetConsumption_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeId | Costing->AssetType_Id | integer | int64 |\r\n| assetTypeCode | Costing->AssetType_Code | string | |\r\n| assetTypeDescription | Costing->AssetType_Description | string | |\r\n| assetTypeRecordType | Costing->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| baseCurrencyId | Costing->BaseCurrency_Id | integer | int64 |\r\n| baseCurrencyCode | Costing->BaseCurrency_Code | string | |\r\n| conversionRateId | Costing->ConversionRate_Id | integer | int64 |\r\n| conversionRateSourceCurrencyId | Costing->ConversionRate_SourceCurrency_Id | integer | int64 |\r\n| conversionRateSourceCurrencyCode | Costing->ConversionRate_SourceCurrency_Code | string | |\r\n| conversionRateTargetCurrencyId | Costing->ConversionRate_TargetCurrency_Id | integer | int64 |\r\n| conversionRateTargetCurrencyCode | Costing->ConversionRate_TargetCurrency_Code | string | |\r\n| conversionRateValue | Costing->ConversionRateValue | number | decimal |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| description | Costing->Description | string | |\r\n| evaluatedForBudget | Costing->EvaluatedForBudget | boolean | |\r\n| expenseType | Costing->ExpenseType | string (Allowed values: [Resource, Stock, CodedNonStock, DirectPurchase, Contractor, WorkOrderAdHoc, AssetConsumption, Other]) | enum |\r\n| financialYearPeriodId | Costing->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | Costing->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Costing->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | Costing->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | Costing->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Costing->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| origin | Costing->Origin | string (Allowed values: [Standard, Manual, Legacy]) | enum |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| requisitionItemTransactionId | Costing->RequisitionItemTransaction_Id | integer | int64 |\r\n| requisitionItemTransactionRequisitionItemId | Costing->RequisitionItemTransaction_RequisitionItem_Id | integer | int64 |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareId | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Id | integer | int64 |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareCode | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Code | string | |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareDescription | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Description | string | |\r\n| siteCurrencyId | Costing->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | Costing->SiteCurrency_Code | string | |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| transactedOn | Costing->TransactedOn | string | date-time |\r\n| unitOfMeasurementId | Costing->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Costing->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Costing->UnitOfMeasurement_Description | string | |\r\n| unitPriceInSiteCurrency | Costing->UnitPriceInSiteCurrency | number | decimal |\r\n| workOrderId | Costing->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Costing->WorkOrder_Code | string | |\r\n| workOrderDescription | Costing->WorkOrder_Description | string | |\r\n| workOrderAssetId | Costing->WorkOrderAsset_Id | integer | int64 |\r\n| workOrderAssetCode | Costing->WorkOrderAsset_Code | string | |\r\n| workOrderAssetDescription | Costing->WorkOrderAsset_Description | string | |\r\n| workOrderAssetRecordType | Costing->WorkOrderAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskAdHocCostId | Costing->WorkOrderTaskAdHocCost_Id | integer | int64 |\r\n| workOrderTaskAdHocCostCode | Costing->WorkOrderTaskAdHocCost_Code | string | |\r\n| workOrderTaskAdHocCostDescription | Costing->WorkOrderTaskAdHocCost_Description | string | |\r\n| workOrderTaskAdHocCostTotalCost | Costing->WorkOrderTaskAdHocCost_TotalCost | number | decimal |\r\n| workOrderTaskAdHocCostTransactedOn | Costing->WorkOrderTaskAdHocCost_TransactedOn | string | date-time |\r\n| workOrderTaskAssetId | Costing->WorkOrderTaskAsset_Id | integer | int64 |\r\n| workOrderTaskAssetCode | Costing->WorkOrderTaskAsset_Code | string | |\r\n| workOrderTaskAssetDescription | Costing->WorkOrderTaskAsset_Description | string | |\r\n| workOrderTaskAssetRecordType | Costing->WorkOrderTaskAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskResourceId | Costing->WorkOrderTaskResource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceId | Costing->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | Costing->WorkOrderTaskResource_Resource_Code | string | |\r\n| workOrderTaskResourceResourceDescription | Costing->WorkOrderTaskResource_Resource_Description | string | |\r\n| workOrderTaskResourceResourceResourceType | Costing->WorkOrderTaskResource_Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| workOrderTaskResourceUsageId | Costing->WorkOrderTaskResourceUsage_Id | integer | int64 |\r\n| workOrderTaskResourceUsageCostInResourceCurrency | Costing->WorkOrderTaskResourceUsage_CostInResourceCurrency | number | decimal |\r\n| workOrderTaskResourceUsageCostInWorkOrderCurrency | Costing->WorkOrderTaskResourceUsage_CostInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskSpareId | Costing->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | Costing->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | Costing->WorkOrderTaskSpare_Description | string | |\r\n", "operationId": "GetCosting", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Costing Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Costing", "schema": { "$ref": "#/definitions/GetCostingResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing": { "get": { "tags": [ "Costing" ], "summary": "Get a collection of Costing resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Costing->Id | integer | int64 |\r\n| version | Costing->Version | integer | int32 |\r\n| description | Costing->Description | string | |\r\n| workOrderId | Costing->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Costing->WorkOrder_Code | string | |\r\n| workOrderDescription | Costing->WorkOrder_Description | string | |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n| assetTypeId | Costing->AssetType_Id | integer | int64 |\r\n| assetTypeCode | Costing->AssetType_Code | string | |\r\n| assetTypeDescription | Costing->AssetType_Description | string | |\r\n| assetTypeRecordType | Costing->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderAssetId | Costing->WorkOrderAsset_Id | integer | int64 |\r\n| workOrderAssetCode | Costing->WorkOrderAsset_Code | string | |\r\n| workOrderAssetDescription | Costing->WorkOrderAsset_Description | string | |\r\n| workOrderAssetRecordType | Costing->WorkOrderAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskAssetId | Costing->WorkOrderTaskAsset_Id | integer | int64 |\r\n| workOrderTaskAssetCode | Costing->WorkOrderTaskAsset_Code | string | |\r\n| workOrderTaskAssetDescription | Costing->WorkOrderTaskAsset_Description | string | |\r\n| workOrderTaskAssetRecordType | Costing->WorkOrderTaskAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskSpareId | Costing->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | Costing->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | Costing->WorkOrderTaskSpare_Description | string | |\r\n| expenseType | Costing->ExpenseType | string (Allowed values: [Resource, Stock, CodedNonStock, DirectPurchase, Contractor, WorkOrderAdHoc, AssetConsumption, Other]) | enum |\r\n| origin | Costing->Origin | string (Allowed values: [Standard, Manual, Legacy]) | enum |\r\n| transactedOn | Costing->TransactedOn | string | date-time |\r\n| financialYearPeriodId | Costing->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | Costing->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | Costing->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Costing->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | Costing->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Costing->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| unitPriceInSiteCurrency | Costing->UnitPriceInSiteCurrency | number | decimal |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| unitOfMeasurementId | Costing->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Costing->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Costing->UnitOfMeasurement_Description | string | |\r\n| requisitionItemTransactionId | Costing->RequisitionItemTransaction_Id | integer | int64 |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareCode | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Code | string | |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareDescription | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Description | string | |\r\n| siteCurrencyId | Costing->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | Costing->SiteCurrency_Code | string | |\r\n| baseCurrencyId | Costing->BaseCurrency_Id | integer | int64 |\r\n| baseCurrencyCode | Costing->BaseCurrency_Code | string | |\r\n| workOrderTaskResourceId | Costing->WorkOrderTaskResource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceId | Costing->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | Costing->WorkOrderTaskResource_Resource_Code | string | |\r\n| workOrderTaskResourceResourceDescription | Costing->WorkOrderTaskResource_Resource_Description | string | |\r\n| workOrderTaskAdHocCostId | Costing->WorkOrderTaskAdHocCost_Id | integer | int64 |\r\n| workOrderTaskAdHocCostDescription | Costing->WorkOrderTaskAdHocCost_Description | string | |\r\n| conversionRateId | Costing->ConversionRate_Id | integer | int64 |\r\n| conversionRateValue | Costing->ConversionRateValue | number | decimal |\r\n| workOrderTaskResourceUsageId | Costing->WorkOrderTaskResourceUsage_Id | integer | int64 |\r\n", "operationId": "GetCostingCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Costing collection", "schema": { "$ref": "#/definitions/GetCostingCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Costing" ], "summary": "Create a new Costing resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| assetId | Costing->Asset_Id | integer | int64 |\r\n| permissionTreeId | Costing->PermissionTree_Id | integer | int64 |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| workOrderId | Costing->WorkOrder_Id | integer | int64 |\r\n| financialYearPeriodId | Costing->FinancialYearPeriod_Id | integer | int64 |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| unitOfMeasurementId | Costing->UnitOfMeasurement_Id | integer | int64 |\r\n| transactedOn | Costing->TransactedOn | string | date-time |\r\n| expenseType | Costing->ExpenseType | string (Allowed values: [Resource, Stock, CodedNonStock, DirectPurchase, Contractor, WorkOrderAdHoc, AssetConsumption, Other]) | enum |\r\n| unitPriceInSiteCurrency | Costing->UnitPriceInSiteCurrency | number | decimal |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| description | Costing->Description | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| transactedOn | Nullable | False | |\r\n| expenseType | Nullable | False | |\r\n| unitPriceInSiteCurrency | Required | True | |\r\n| unitPriceInSiteCurrency | Nullable | False | |\r\n| quantity | System Generated | true | If no value specified |\r\n| quantity | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateCosting", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCostingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/Lookups/LookupCostingChangePermissionTree": { "get": { "tags": [ "Costing" ], "summary": "Lookup the permission set for changing the Costing.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostingChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostingChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/Lookups/LookupCostingInsertPermissionTree": { "get": { "tags": [ "Costing" ], "summary": "Lookup the permission set for creating the Costing.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCostingInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CostingInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/Batch/{ids}": { "get": { "tags": [ "Costing" ], "summary": "Get a collection of Costing resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | Costing->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Costing->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Costing->CreatedByUser_FullName | string | |\r\n| createdOn | Costing->CreatedOn | string | date-time |\r\n| modifiedByUserId | Costing->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Costing->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Costing->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Costing->ModifiedOn | string | date-time |\r\n| version | Costing->Version | integer | int32 |\r\n| permissionTreeId | Costing->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Costing->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Costing->PermissionTree_Description | string | |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n| id | Costing->Id | integer | int64 |\r\n| assetId | Costing->Asset_Id | integer | int64 |\r\n| assetCode | Costing->Asset_Code | string | |\r\n| assetDescription | Costing->Asset_Description | string | |\r\n| assetRecordType | Costing->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetConsumptionId | Costing->AssetConsumption_Id | integer | int64 |\r\n| assetConsumptionAssetId | Costing->AssetConsumption_Asset_Id | integer | int64 |\r\n| assetConsumptionAssetCode | Costing->AssetConsumption_Asset_Code | string | |\r\n| assetConsumptionAssetDescription | Costing->AssetConsumption_Asset_Description | string | |\r\n| assetConsumptionAssetIsMsi | Costing->AssetConsumption_Asset_IsMsi | boolean | |\r\n| assetConsumptionAssetRecordType | Costing->AssetConsumption_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeId | Costing->AssetType_Id | integer | int64 |\r\n| assetTypeCode | Costing->AssetType_Code | string | |\r\n| assetTypeDescription | Costing->AssetType_Description | string | |\r\n| assetTypeRecordType | Costing->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| baseCurrencyId | Costing->BaseCurrency_Id | integer | int64 |\r\n| baseCurrencyCode | Costing->BaseCurrency_Code | string | |\r\n| conversionRateId | Costing->ConversionRate_Id | integer | int64 |\r\n| conversionRateSourceCurrencyId | Costing->ConversionRate_SourceCurrency_Id | integer | int64 |\r\n| conversionRateSourceCurrencyCode | Costing->ConversionRate_SourceCurrency_Code | string | |\r\n| conversionRateTargetCurrencyId | Costing->ConversionRate_TargetCurrency_Id | integer | int64 |\r\n| conversionRateTargetCurrencyCode | Costing->ConversionRate_TargetCurrency_Code | string | |\r\n| conversionRateValue | Costing->ConversionRateValue | number | decimal |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| description | Costing->Description | string | |\r\n| evaluatedForBudget | Costing->EvaluatedForBudget | boolean | |\r\n| expenseType | Costing->ExpenseType | string (Allowed values: [Resource, Stock, CodedNonStock, DirectPurchase, Contractor, WorkOrderAdHoc, AssetConsumption, Other]) | enum |\r\n| financialYearPeriodId | Costing->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | Costing->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Costing->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | Costing->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | Costing->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Costing->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| origin | Costing->Origin | string (Allowed values: [Standard, Manual, Legacy]) | enum |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| requisitionItemTransactionId | Costing->RequisitionItemTransaction_Id | integer | int64 |\r\n| requisitionItemTransactionRequisitionItemId | Costing->RequisitionItemTransaction_RequisitionItem_Id | integer | int64 |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareId | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Id | integer | int64 |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareCode | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Code | string | |\r\n| requisitionItemTransactionRequisitionItemWorkOrderTaskSpareDescription | Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Description | string | |\r\n| siteCurrencyId | Costing->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | Costing->SiteCurrency_Code | string | |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| transactedOn | Costing->TransactedOn | string | date-time |\r\n| unitOfMeasurementId | Costing->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Costing->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Costing->UnitOfMeasurement_Description | string | |\r\n| unitPriceInSiteCurrency | Costing->UnitPriceInSiteCurrency | number | decimal |\r\n| workOrderId | Costing->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Costing->WorkOrder_Code | string | |\r\n| workOrderDescription | Costing->WorkOrder_Description | string | |\r\n| workOrderAssetId | Costing->WorkOrderAsset_Id | integer | int64 |\r\n| workOrderAssetCode | Costing->WorkOrderAsset_Code | string | |\r\n| workOrderAssetDescription | Costing->WorkOrderAsset_Description | string | |\r\n| workOrderAssetRecordType | Costing->WorkOrderAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskAdHocCostId | Costing->WorkOrderTaskAdHocCost_Id | integer | int64 |\r\n| workOrderTaskAdHocCostCode | Costing->WorkOrderTaskAdHocCost_Code | string | |\r\n| workOrderTaskAdHocCostDescription | Costing->WorkOrderTaskAdHocCost_Description | string | |\r\n| workOrderTaskAdHocCostTotalCost | Costing->WorkOrderTaskAdHocCost_TotalCost | number | decimal |\r\n| workOrderTaskAdHocCostTransactedOn | Costing->WorkOrderTaskAdHocCost_TransactedOn | string | date-time |\r\n| workOrderTaskAssetId | Costing->WorkOrderTaskAsset_Id | integer | int64 |\r\n| workOrderTaskAssetCode | Costing->WorkOrderTaskAsset_Code | string | |\r\n| workOrderTaskAssetDescription | Costing->WorkOrderTaskAsset_Description | string | |\r\n| workOrderTaskAssetRecordType | Costing->WorkOrderTaskAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskResourceId | Costing->WorkOrderTaskResource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceId | Costing->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | Costing->WorkOrderTaskResource_Resource_Code | string | |\r\n| workOrderTaskResourceResourceDescription | Costing->WorkOrderTaskResource_Resource_Description | string | |\r\n| workOrderTaskResourceResourceResourceType | Costing->WorkOrderTaskResource_Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| workOrderTaskResourceUsageId | Costing->WorkOrderTaskResourceUsage_Id | integer | int64 |\r\n| workOrderTaskResourceUsageCostInResourceCurrency | Costing->WorkOrderTaskResourceUsage_CostInResourceCurrency | number | decimal |\r\n| workOrderTaskResourceUsageCostInWorkOrderCurrency | Costing->WorkOrderTaskResourceUsage_CostInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskSpareId | Costing->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | Costing->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | Costing->WorkOrderTaskSpare_Description | string | |\r\n", "operationId": "BatchGetCosting", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Costing id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Costing collection", "schema": { "$ref": "#/definitions/BatchGetCostingResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/Batch": { "post": { "tags": [ "Costing" ], "summary": "Create a new collection of Costing resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| assetId | Costing->Asset_Id | integer | int64 |\r\n| permissionTreeId | Costing->PermissionTree_Id | integer | int64 |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| workOrderId | Costing->WorkOrder_Id | integer | int64 |\r\n| financialYearPeriodId | Costing->FinancialYearPeriod_Id | integer | int64 |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| unitOfMeasurementId | Costing->UnitOfMeasurement_Id | integer | int64 |\r\n| transactedOn | Costing->TransactedOn | string | date-time |\r\n| expenseType | Costing->ExpenseType | string (Allowed values: [Resource, Stock, CodedNonStock, DirectPurchase, Contractor, WorkOrderAdHoc, AssetConsumption, Other]) | enum |\r\n| unitPriceInSiteCurrency | Costing->UnitPriceInSiteCurrency | number | decimal |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| description | Costing->Description | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| transactedOn | Nullable | False | |\r\n| expenseType | Nullable | False | |\r\n| unitPriceInSiteCurrency | Required | True | |\r\n| unitPriceInSiteCurrency | Nullable | False | |\r\n| quantity | System Generated | true | If no value specified |\r\n| quantity | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateCosting", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCostingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Costing batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/Budgets/{id}": { "get": { "tags": [ "Costing Budget" ], "summary": "Get a Costing Budget resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | CostingBudget->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostingBudget->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostingBudget->CreatedByUser_FullName | string | |\r\n| createdOn | CostingBudget->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostingBudget->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostingBudget->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostingBudget->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostingBudget->ModifiedOn | string | date-time |\r\n| version | CostingBudget->Version | integer | int32 |\r\n| permissionTreeId | CostingBudget->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostingBudget->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostingBudget->PermissionTree_Description | string | |\r\n| id | CostingBudget->Id | integer | int64 |\r\n| budgetId | CostingBudget->Budget_Id | integer | int64 |\r\n| budgetBudgetAmount | CostingBudget->Budget_BudgetAmount | number | decimal |\r\n| budgetCurrencyId | CostingBudget->Budget_Currency_Id | integer | int64 |\r\n| budgetCurrencyCode | CostingBudget->Budget_Currency_Code | string | |\r\n| budgetCurrencyDescription | CostingBudget->Budget_Currency_Description | string | |\r\n| budgetFinancialYearPeriodId | CostingBudget->Budget_FinancialYearPeriod_Id | integer | int64 |\r\n| budgetFinancialYearPeriodCode | CostingBudget->Budget_FinancialYearPeriod_Code | string | |\r\n| budgetFinancialYearPeriodDescription | CostingBudget->Budget_FinancialYearPeriod_Description | string | |\r\n| budgetFinancialYearPeriodFinancialYearId | CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| budgetFinancialYearPeriodFinancialYearCode | CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Code | string | |\r\n| budgetFinancialYearPeriodFinancialYearDescription | CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Description | string | |\r\n| costingId | CostingBudget->Costing_Id | integer | int64 |\r\n| costingDescription | CostingBudget->Costing_Description | string | |\r\n", "operationId": "GetCostingBudget", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Costing Budget Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Costing Budget", "schema": { "$ref": "#/definitions/GetCostingBudgetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/Budgets": { "get": { "tags": [ "Costing Budget" ], "summary": "Get a collection of Costing Budget resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CostingBudget->Version | integer | int32 |\r\n| id | CostingBudget->Id | integer | int64 |\r\n| costingId | CostingBudget->Costing_Id | integer | int64 |\r\n| costingDescription | CostingBudget->Costing_Description | string | |\r\n| budgetId | CostingBudget->Budget_Id | integer | int64 |\r\n| createdOn | CostingBudget->CreatedOn | string | date-time |\r\n| modifiedOn | CostingBudget->ModifiedOn | string | date-time |\r\n", "operationId": "GetCostingBudgetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Costing Budget collection", "schema": { "$ref": "#/definitions/GetCostingBudgetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Costing/Budgets/Batch/{ids}": { "get": { "tags": [ "Costing Budget" ], "summary": "Get a collection of Costing Budget resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | CostingBudget->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CostingBudget->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CostingBudget->CreatedByUser_FullName | string | |\r\n| createdOn | CostingBudget->CreatedOn | string | date-time |\r\n| modifiedByUserId | CostingBudget->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CostingBudget->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CostingBudget->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CostingBudget->ModifiedOn | string | date-time |\r\n| version | CostingBudget->Version | integer | int32 |\r\n| permissionTreeId | CostingBudget->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | CostingBudget->PermissionTree_Code | string | |\r\n| permissionTreeDescription | CostingBudget->PermissionTree_Description | string | |\r\n| id | CostingBudget->Id | integer | int64 |\r\n| budgetId | CostingBudget->Budget_Id | integer | int64 |\r\n| budgetBudgetAmount | CostingBudget->Budget_BudgetAmount | number | decimal |\r\n| budgetCurrencyId | CostingBudget->Budget_Currency_Id | integer | int64 |\r\n| budgetCurrencyCode | CostingBudget->Budget_Currency_Code | string | |\r\n| budgetCurrencyDescription | CostingBudget->Budget_Currency_Description | string | |\r\n| budgetFinancialYearPeriodId | CostingBudget->Budget_FinancialYearPeriod_Id | integer | int64 |\r\n| budgetFinancialYearPeriodCode | CostingBudget->Budget_FinancialYearPeriod_Code | string | |\r\n| budgetFinancialYearPeriodDescription | CostingBudget->Budget_FinancialYearPeriod_Description | string | |\r\n| budgetFinancialYearPeriodFinancialYearId | CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| budgetFinancialYearPeriodFinancialYearCode | CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Code | string | |\r\n| budgetFinancialYearPeriodFinancialYearDescription | CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Description | string | |\r\n| costingId | CostingBudget->Costing_Id | integer | int64 |\r\n| costingDescription | CostingBudget->Costing_Description | string | |\r\n", "operationId": "BatchGetCostingBudget", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Costing Budget id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Costing Budget collection", "schema": { "$ref": "#/definitions/BatchGetCostingBudgetResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/{id}": { "get": { "tags": [ "Currency" ], "summary": "Get a Currency resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Currency->Code | string | |\r\n| createdByUserId | Currency->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Currency->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Currency->CreatedByUser_FullName | string | |\r\n| createdOn | Currency->CreatedOn | string | date-time |\r\n| isActive | Currency->IsActive | boolean | |\r\n| modifiedByUserId | Currency->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Currency->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Currency->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Currency->ModifiedOn | string | date-time |\r\n| permissionTreeId | Currency->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Currency->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Currency->PermissionTree_Description | string | |\r\n| version | Currency->Version | integer | int32 |\r\n| id | Currency->Id | integer | int64 |\r\n| description | Currency->Description | string | |\r\n| isoCode | Currency->IsoCode | string | |\r\n| notes | Currency->Notes | string | |\r\n| sequenceNumber | Currency->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCurrency", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Currency Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Currency", "schema": { "$ref": "#/definitions/GetCurrencyResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Currency" ], "summary": "Update an existing Currency resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Currency->Version | integer | int32 |\r\n| code | Currency->Code | string | |\r\n| isoCode | Currency->IsoCode | string | |\r\n| description | Currency->Description | string | |\r\n| sequenceNumber | Currency->SequenceNumber | integer | int32 |\r\n| notes | Currency->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| isoCode | Nullable | False | |\r\n| isoCode | Min Length | >= 1 chars| |\r\n| isoCode | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateCurrency", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Currency Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCurrencyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Currency was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Currency" ], "summary": "Delete an existing Currency resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Currency->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteCurrency", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Currency Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCurrencyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Currency was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies": { "get": { "tags": [ "Currency" ], "summary": "Get a collection of Currency resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Currency->Version | integer | int32 |\r\n| id | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n| sequenceNumber | Currency->SequenceNumber | integer | int32 |\r\n| isoCode | Currency->IsoCode | string | |\r\n| isActive | Currency->IsActive | boolean | |\r\n| notes | Currency->Notes | string | |\r\n| createdOn | Currency->CreatedOn | string | date-time |\r\n| modifiedOn | Currency->ModifiedOn | string | date-time |\r\n", "operationId": "GetCurrencyCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/GetCurrencyCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Currency" ], "summary": "Create a new Currency resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Currency->PermissionTree_Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n| sequenceNumber | Currency->SequenceNumber | integer | int32 |\r\n| isoCode | Currency->IsoCode | string | |\r\n| notes | Currency->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isoCode | Required | True | |\r\n| isoCode | Nullable | False | |\r\n| isoCode | Min Length | >= 1 chars| |\r\n| isoCode | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "CreateCurrency", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCurrencyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Lookups/LookupCurrencyChangePermissionTree": { "get": { "tags": [ "Currency" ], "summary": "Lookup the permission set for changing the Currency.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCurrencyChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CurrencyChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Lookups/LookupCurrencyInsertPermissionTree": { "get": { "tags": [ "Currency" ], "summary": "Lookup the permission set for creating the Currency.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupCurrencyInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/CurrencyInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Batch/{ids}": { "get": { "tags": [ "Currency" ], "summary": "Get a collection of Currency resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Currency->Code | string | |\r\n| createdByUserId | Currency->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Currency->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Currency->CreatedByUser_FullName | string | |\r\n| createdOn | Currency->CreatedOn | string | date-time |\r\n| isActive | Currency->IsActive | boolean | |\r\n| modifiedByUserId | Currency->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Currency->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Currency->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Currency->ModifiedOn | string | date-time |\r\n| permissionTreeId | Currency->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Currency->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Currency->PermissionTree_Description | string | |\r\n| version | Currency->Version | integer | int32 |\r\n| id | Currency->Id | integer | int64 |\r\n| description | Currency->Description | string | |\r\n| isoCode | Currency->IsoCode | string | |\r\n| notes | Currency->Notes | string | |\r\n| sequenceNumber | Currency->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCurrency", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Currency id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Currency collection", "schema": { "$ref": "#/definitions/BatchGetCurrencyResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Batch": { "post": { "tags": [ "Currency" ], "summary": "Create a new collection of Currency resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Currency->PermissionTree_Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n| sequenceNumber | Currency->SequenceNumber | integer | int32 |\r\n| isoCode | Currency->IsoCode | string | |\r\n| notes | Currency->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isoCode | Required | True | |\r\n| isoCode | Nullable | False | |\r\n| isoCode | Min Length | >= 1 chars| |\r\n| isoCode | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchCreateCurrency", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCurrencyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Currency batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Currency" ], "summary": "Update a collection of existing Currency resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| version | Currency->Version | integer | int32 |\r\n| code | Currency->Code | string | |\r\n| isoCode | Currency->IsoCode | string | |\r\n| description | Currency->Description | string | |\r\n| sequenceNumber | Currency->SequenceNumber | integer | int32 |\r\n| notes | Currency->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| isoCode | Nullable | False | |\r\n| isoCode | Min Length | >= 1 chars| |\r\n| isoCode | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateCurrency", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCurrencyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Currency batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Currency" ], "summary": "Delete a collection of existing Currency resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| version | Currency->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteCurrency", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteCurrencyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Currency batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/{id}/Active": { "patch": { "tags": [ "Currency" ], "summary": "Change the IsActive status for an existing Currency resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Currency->Version | integer | int32 |\r\n| isActive | Currency->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeCurrencyIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Currency Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCurrencyIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/{id}/PermissionTree": { "patch": { "tags": [ "Currency" ], "summary": "Change the PermissionTree for an existing Currency resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Currency->Version | integer | int32 |\r\n| permissionTreeId | Currency->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeCurrencyPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Currency Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCurrencyPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Batch/Active": { "patch": { "tags": [ "Currency" ], "summary": "Change the IsActive status for a collection of existing Currency resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| version | Currency->Version | integer | int32 |\r\n| isActive | Currency->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCurrencyIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCurrencyIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Batch/PermissionTree": { "patch": { "tags": [ "Currency" ], "summary": "Change the PermissionTree status for a collection of existing Currency resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| version | Currency->Version | integer | int32 |\r\n| permissionTreeId | Currency->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeCurrencyPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeCurrencyPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Rates/{id}": { "get": { "tags": [ "Currency Rate" ], "summary": "Get a Currency Rate resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | CurrencyRate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CurrencyRate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CurrencyRate->CreatedByUser_FullName | string | |\r\n| createdOn | CurrencyRate->CreatedOn | string | date-time |\r\n| modifiedByUserId | CurrencyRate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CurrencyRate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CurrencyRate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CurrencyRate->ModifiedOn | string | date-time |\r\n| version | CurrencyRate->Version | integer | int32 |\r\n| id | CurrencyRate->Id | integer | int64 |\r\n| allowedVariancePercentage | CurrencyRate->AllowedVariancePercentage | number | decimal |\r\n| applicableFrom | CurrencyRate->ApplicableFrom | string | date-time |\r\n| applicableTo | CurrencyRate->ApplicableTo | string | date-time |\r\n| appliedConversionRate | CurrencyRate->AppliedConversionRate | number | decimal |\r\n| conversionType | CurrencyRate->ConversionType | string (Allowed values: [Multiply, Divide]) | enum |\r\n| isLatest | CurrencyRate->IsLatest | boolean | |\r\n| notes | CurrencyRate->Notes | string | |\r\n| sourceCurrencyId | CurrencyRate->SourceCurrency_Id | integer | int64 |\r\n| sourceCurrencyCode | CurrencyRate->SourceCurrency_Code | string | |\r\n| sourceCurrencyDescription | CurrencyRate->SourceCurrency_Description | string | |\r\n| targetCurrencyId | CurrencyRate->TargetCurrency_Id | integer | int64 |\r\n| targetCurrencyCode | CurrencyRate->TargetCurrency_Code | string | |\r\n| targetCurrencyDescription | CurrencyRate->TargetCurrency_Description | string | |\r\n| userSuppliedConversionRate | CurrencyRate->UserSuppliedConversionRate | number | decimal |\r\n", "operationId": "GetCurrencyRate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Currency Rate Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Currency Rate", "schema": { "$ref": "#/definitions/GetCurrencyRateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Currency Rate" ], "summary": "Update an existing Currency Rate resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | CurrencyRate->Version | integer | int32 |\r\n| notes | CurrencyRate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateCurrencyRate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Currency Rate Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCurrencyRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Currency Rate was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Rates": { "get": { "tags": [ "Currency Rate" ], "summary": "Get a collection of Currency Rate resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CurrencyRate->Id | integer | int64 |\r\n| version | CurrencyRate->Version | integer | int32 |\r\n| allowedVariancePercentage | CurrencyRate->AllowedVariancePercentage | number | decimal |\r\n| applicableFrom | CurrencyRate->ApplicableFrom | string | date-time |\r\n| applicableTo | CurrencyRate->ApplicableTo | string | date-time |\r\n| appliedConversionRate | CurrencyRate->AppliedConversionRate | number | decimal |\r\n| conversionType | CurrencyRate->ConversionType | string (Allowed values: [Multiply, Divide]) | enum |\r\n| isLatest | CurrencyRate->IsLatest | boolean | |\r\n| notes | CurrencyRate->Notes | string | |\r\n| sourceCurrencyId | CurrencyRate->SourceCurrency_Id | integer | int64 |\r\n| sourceCurrencyCode | CurrencyRate->SourceCurrency_Code | string | |\r\n| sourceCurrencyDescription | CurrencyRate->SourceCurrency_Description | string | |\r\n| targetCurrencyId | CurrencyRate->TargetCurrency_Id | integer | int64 |\r\n| targetCurrencyCode | CurrencyRate->TargetCurrency_Code | string | |\r\n| targetCurrencyDescription | CurrencyRate->TargetCurrency_Description | string | |\r\n| userSuppliedConversionRate | CurrencyRate->UserSuppliedConversionRate | number | decimal |\r\n", "operationId": "GetCurrencyRateCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency Rate collection", "schema": { "$ref": "#/definitions/GetCurrencyRateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Currency Rate" ], "summary": "Create a new Currency Rate resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| targetCurrencyId | CurrencyRate->TargetCurrency_Id | integer | int64 |\r\n| sourceCurrencyId | CurrencyRate->SourceCurrency_Id | integer | int64 |\r\n| conversionType | CurrencyRate->ConversionType | string (Allowed values: [Multiply, Divide]) | enum |\r\n| userSuppliedConversionRate | CurrencyRate->UserSuppliedConversionRate | number | decimal |\r\n| allowedVariancePercentage | CurrencyRate->AllowedVariancePercentage | number | decimal |\r\n| notes | CurrencyRate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| targetCurrencyId | Nullable | False | |\r\n| sourceCurrencyId | Nullable | False | |\r\n| conversionType | Nullable | False | |\r\n| userSuppliedConversionRate | Nullable | False | |\r\n| userSuppliedConversionRate | Min Value | > 0| |\r\n| allowedVariancePercentage | Nullable | False | |\r\n| allowedVariancePercentage | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateCurrencyRate", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateCurrencyRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/{sourceCurrencyId}/Rates": { "get": { "tags": [ "Currency Rate" ], "summary": "Get a collection of Currency Rate resources for the Currency.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CurrencyRate->Id | integer | int64 |\r\n| version | CurrencyRate->Version | integer | int32 |\r\n| allowedVariancePercentage | CurrencyRate->AllowedVariancePercentage | number | decimal |\r\n| applicableFrom | CurrencyRate->ApplicableFrom | string | date-time |\r\n| applicableTo | CurrencyRate->ApplicableTo | string | date-time |\r\n| appliedConversionRate | CurrencyRate->AppliedConversionRate | number | decimal |\r\n| conversionType | CurrencyRate->ConversionType | string (Allowed values: [Multiply, Divide]) | enum |\r\n| isLatest | CurrencyRate->IsLatest | boolean | |\r\n| notes | CurrencyRate->Notes | string | |\r\n| sourceCurrencyId | CurrencyRate->SourceCurrency_Id | integer | int64 |\r\n| sourceCurrencyCode | CurrencyRate->SourceCurrency_Code | string | |\r\n| sourceCurrencyDescription | CurrencyRate->SourceCurrency_Description | string | |\r\n| targetCurrencyId | CurrencyRate->TargetCurrency_Id | integer | int64 |\r\n| targetCurrencyCode | CurrencyRate->TargetCurrency_Code | string | |\r\n| targetCurrencyDescription | CurrencyRate->TargetCurrency_Description | string | |\r\n| userSuppliedConversionRate | CurrencyRate->UserSuppliedConversionRate | number | decimal |\r\n", "operationId": "GetCurrencyRateForCurrencyCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "sourceCurrencyId", "in": "path", "required": true, "description": "Currency Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency Rate collection", "schema": { "$ref": "#/definitions/GetCurrencyRateForCurrencyCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Rates/Lookups/LookupCurrencyRateSourceCurrency": { "get": { "tags": [ "Currency Rate" ], "summary": "Lookup the Currency for the Currency Rate.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupCurrencyRateSourceCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/CurrencyRateSourceCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Rates/Lookups/LookupCurrencyRateTargetCurrency": { "get": { "tags": [ "Currency Rate" ], "summary": "Lookup the Currency for the Currency Rate.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupCurrencyRateTargetCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/CurrencyRateTargetCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Rates/Batch/{ids}": { "get": { "tags": [ "Currency Rate" ], "summary": "Get a collection of Currency Rate resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | CurrencyRate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CurrencyRate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CurrencyRate->CreatedByUser_FullName | string | |\r\n| createdOn | CurrencyRate->CreatedOn | string | date-time |\r\n| modifiedByUserId | CurrencyRate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CurrencyRate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CurrencyRate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CurrencyRate->ModifiedOn | string | date-time |\r\n| version | CurrencyRate->Version | integer | int32 |\r\n| id | CurrencyRate->Id | integer | int64 |\r\n| allowedVariancePercentage | CurrencyRate->AllowedVariancePercentage | number | decimal |\r\n| applicableFrom | CurrencyRate->ApplicableFrom | string | date-time |\r\n| applicableTo | CurrencyRate->ApplicableTo | string | date-time |\r\n| appliedConversionRate | CurrencyRate->AppliedConversionRate | number | decimal |\r\n| conversionType | CurrencyRate->ConversionType | string (Allowed values: [Multiply, Divide]) | enum |\r\n| isLatest | CurrencyRate->IsLatest | boolean | |\r\n| notes | CurrencyRate->Notes | string | |\r\n| sourceCurrencyId | CurrencyRate->SourceCurrency_Id | integer | int64 |\r\n| sourceCurrencyCode | CurrencyRate->SourceCurrency_Code | string | |\r\n| sourceCurrencyDescription | CurrencyRate->SourceCurrency_Description | string | |\r\n| targetCurrencyId | CurrencyRate->TargetCurrency_Id | integer | int64 |\r\n| targetCurrencyCode | CurrencyRate->TargetCurrency_Code | string | |\r\n| targetCurrencyDescription | CurrencyRate->TargetCurrency_Description | string | |\r\n| userSuppliedConversionRate | CurrencyRate->UserSuppliedConversionRate | number | decimal |\r\n", "operationId": "BatchGetCurrencyRate", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Currency Rate id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Currency Rate collection", "schema": { "$ref": "#/definitions/BatchGetCurrencyRateResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/Currencies/Rates/Batch": { "post": { "tags": [ "Currency Rate" ], "summary": "Create a new collection of Currency Rate resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| targetCurrencyId | CurrencyRate->TargetCurrency_Id | integer | int64 |\r\n| sourceCurrencyId | CurrencyRate->SourceCurrency_Id | integer | int64 |\r\n| conversionType | CurrencyRate->ConversionType | string (Allowed values: [Multiply, Divide]) | enum |\r\n| userSuppliedConversionRate | CurrencyRate->UserSuppliedConversionRate | number | decimal |\r\n| allowedVariancePercentage | CurrencyRate->AllowedVariancePercentage | number | decimal |\r\n| notes | CurrencyRate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| targetCurrencyId | Nullable | False | |\r\n| sourceCurrencyId | Nullable | False | |\r\n| conversionType | Nullable | False | |\r\n| userSuppliedConversionRate | Nullable | False | |\r\n| userSuppliedConversionRate | Min Value | > 0| |\r\n| allowedVariancePercentage | Nullable | False | |\r\n| allowedVariancePercentage | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateCurrencyRate", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateCurrencyRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Currency Rate batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Currency Rate" ], "summary": "Update a collection of existing Currency Rate resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CurrencyRate->Id | integer | int64 |\r\n| version | CurrencyRate->Version | integer | int32 |\r\n| notes | CurrencyRate->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateCurrencyRate", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateCurrencyRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Currency Rate batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/{id}": { "get": { "tags": [ "Financial Year" ], "summary": "Get a Financial Year resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FinancialYear->Code | string | |\r\n| createdByUserId | FinancialYear->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FinancialYear->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FinancialYear->CreatedByUser_FullName | string | |\r\n| createdOn | FinancialYear->CreatedOn | string | date-time |\r\n| modifiedByUserId | FinancialYear->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FinancialYear->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FinancialYear->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FinancialYear->ModifiedOn | string | date-time |\r\n| version | FinancialYear->Version | integer | int32 |\r\n| permissionTreeId | FinancialYear->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FinancialYear->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FinancialYear->PermissionTree_Description | string | |\r\n| id | FinancialYear->Id | integer | int64 |\r\n| description | FinancialYear->Description | string | |\r\n| isOpen | FinancialYear->IsOpen | boolean | |\r\n| notes | FinancialYear->Notes | string | |\r\n| startDate | FinancialYear->StartDate | string | date |\r\n| endDate | FinancialYear->EndDate | string | date |\r\n", "operationId": "GetFinancialYear", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Financial Year Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Financial Year", "schema": { "$ref": "#/definitions/GetFinancialYearResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Financial Year" ], "summary": "Update an existing Financial Year resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FinancialYear->Version | integer | int32 |\r\n| code | FinancialYear->Code | string | |\r\n| description | FinancialYear->Description | string | |\r\n| notes | FinancialYear->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateFinancialYear", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Financial Year Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFinancialYearResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Financial Year was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Financial Year" ], "summary": "Delete an existing Financial Year resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FinancialYear->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteFinancialYear", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Financial Year Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFinancialYearResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Financial Year was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears": { "get": { "tags": [ "Financial Year" ], "summary": "Get a collection of Financial Year resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FinancialYear->Version | integer | int32 |\r\n| id | FinancialYear->Id | integer | int64 |\r\n| code | FinancialYear->Code | string | |\r\n| description | FinancialYear->Description | string | |\r\n| startDate | FinancialYear->StartDate | string | date |\r\n| endDate | FinancialYear->EndDate | string | date |\r\n| notes | FinancialYear->Notes | string | |\r\n| isOpen | FinancialYear->IsOpen | boolean | |\r\n| createdOn | FinancialYear->CreatedOn | string | date-time |\r\n| modifiedOn | FinancialYear->ModifiedOn | string | date-time |\r\n", "operationId": "GetFinancialYearCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year collection", "schema": { "$ref": "#/definitions/GetFinancialYearCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Financial Year" ], "summary": "Create a new Financial Year resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FinancialYear->PermissionTree_Id | integer | int64 |\r\n| code | FinancialYear->Code | string | |\r\n| description | FinancialYear->Description | string | |\r\n| startDate | FinancialYear->StartDate | string | date |\r\n| endDate | FinancialYear->EndDate | string | date |\r\n| notes | FinancialYear->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| startDate | Required | True | |\r\n| startDate | Nullable | False | |\r\n| endDate | Required | True | |\r\n| endDate | Nullable | False | |\r\n\r\n", "operationId": "CreateFinancialYear", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateFinancialYearResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Lookups/LookupFinancialYearChangePermissionTree": { "get": { "tags": [ "Financial Year" ], "summary": "Lookup the permission set for changing the Financial Year.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFinancialYearChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/FinancialYearChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Lookups/LookupFinancialYearInsertPermissionTree": { "get": { "tags": [ "Financial Year" ], "summary": "Lookup the permission set for creating the Financial Year.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFinancialYearInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/FinancialYearInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Batch/{ids}": { "get": { "tags": [ "Financial Year" ], "summary": "Get a collection of Financial Year resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FinancialYear->Code | string | |\r\n| createdByUserId | FinancialYear->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FinancialYear->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FinancialYear->CreatedByUser_FullName | string | |\r\n| createdOn | FinancialYear->CreatedOn | string | date-time |\r\n| modifiedByUserId | FinancialYear->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FinancialYear->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FinancialYear->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FinancialYear->ModifiedOn | string | date-time |\r\n| version | FinancialYear->Version | integer | int32 |\r\n| permissionTreeId | FinancialYear->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FinancialYear->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FinancialYear->PermissionTree_Description | string | |\r\n| id | FinancialYear->Id | integer | int64 |\r\n| description | FinancialYear->Description | string | |\r\n| isOpen | FinancialYear->IsOpen | boolean | |\r\n| notes | FinancialYear->Notes | string | |\r\n| startDate | FinancialYear->StartDate | string | date |\r\n| endDate | FinancialYear->EndDate | string | date |\r\n", "operationId": "BatchGetFinancialYear", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Financial Year id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Financial Year collection", "schema": { "$ref": "#/definitions/BatchGetFinancialYearResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Batch": { "post": { "tags": [ "Financial Year" ], "summary": "Create a new collection of Financial Year resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FinancialYear->PermissionTree_Id | integer | int64 |\r\n| code | FinancialYear->Code | string | |\r\n| description | FinancialYear->Description | string | |\r\n| startDate | FinancialYear->StartDate | string | date |\r\n| endDate | FinancialYear->EndDate | string | date |\r\n| notes | FinancialYear->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| startDate | Required | True | |\r\n| startDate | Nullable | False | |\r\n| endDate | Required | True | |\r\n| endDate | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateFinancialYear", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateFinancialYearResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Financial Year batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Financial Year" ], "summary": "Update a collection of existing Financial Year resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYear->Id | integer | int64 |\r\n| version | FinancialYear->Version | integer | int32 |\r\n| code | FinancialYear->Code | string | |\r\n| description | FinancialYear->Description | string | |\r\n| notes | FinancialYear->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateFinancialYear", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateFinancialYearResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Financial Year batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Financial Year" ], "summary": "Delete a collection of existing Financial Year resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYear->Id | integer | int64 |\r\n| version | FinancialYear->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteFinancialYear", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteFinancialYearResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Financial Year batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/{id}/PermissionTree": { "patch": { "tags": [ "Financial Year" ], "summary": "Change the PermissionTree for an existing Financial Year resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FinancialYear->Version | integer | int32 |\r\n| permissionTreeId | FinancialYear->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFinancialYearPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Financial Year Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFinancialYearPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Batch/PermissionTree": { "patch": { "tags": [ "Financial Year" ], "summary": "Change the PermissionTree status for a collection of existing Financial Year resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYear->Id | integer | int64 |\r\n| version | FinancialYear->Version | integer | int32 |\r\n| permissionTreeId | FinancialYear->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFinancialYearPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeFinancialYearPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Periods/{id}": { "get": { "tags": [ "Financial Year Period" ], "summary": "Get a Financial Year Period resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| createdByUserId | FinancialYearPeriod->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FinancialYearPeriod->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FinancialYearPeriod->CreatedByUser_FullName | string | |\r\n| createdOn | FinancialYearPeriod->CreatedOn | string | date-time |\r\n| modifiedByUserId | FinancialYearPeriod->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FinancialYearPeriod->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FinancialYearPeriod->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FinancialYearPeriod->ModifiedOn | string | date-time |\r\n| version | FinancialYearPeriod->Version | integer | int32 |\r\n| permissionTreeId | FinancialYearPeriod->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FinancialYearPeriod->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FinancialYearPeriod->PermissionTree_Description | string | |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| endDate | FinancialYearPeriod->EndDate | string | date |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n| isOpen | FinancialYearPeriod->IsOpen | boolean | |\r\n| notes | FinancialYearPeriod->Notes | string | |\r\n| startDate | FinancialYearPeriod->StartDate | string | date |\r\n", "operationId": "GetFinancialYearPeriod", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Financial Year Period Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Financial Year Period", "schema": { "$ref": "#/definitions/GetFinancialYearPeriodResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Financial Year Period" ], "summary": "Update an existing Financial Year Period resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FinancialYearPeriod->Version | integer | int32 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| startDate | FinancialYearPeriod->StartDate | string | date |\r\n| endDate | FinancialYearPeriod->EndDate | string | date |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| notes | FinancialYearPeriod->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| startDate | Nullable | False | |\r\n| endDate | Nullable | False | |\r\n| financialYearId | Nullable | False | |\r\n\r\n", "operationId": "UpdateFinancialYearPeriod", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Financial Year Period Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFinancialYearPeriodResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Financial Year Period was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/{financialYearId}/FinancialYearPeriods": { "get": { "tags": [ "Financial Year Period" ], "summary": "Get a collection of Financial Year Period resources for the Financial Year.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FinancialYearPeriod->Version | integer | int32 |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| startDate | FinancialYearPeriod->StartDate | string | date |\r\n| endDate | FinancialYearPeriod->EndDate | string | date |\r\n| notes | FinancialYearPeriod->Notes | string | |\r\n| isOpen | FinancialYearPeriod->IsOpen | boolean | |\r\n| createdOn | FinancialYearPeriod->CreatedOn | string | date-time |\r\n| modifiedOn | FinancialYearPeriod->ModifiedOn | string | date-time |\r\n", "operationId": "GetFinancialYearPeriodForFinancialYearCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "financialYearId", "in": "path", "required": true, "description": "Financial Year Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year Period collection", "schema": { "$ref": "#/definitions/GetFinancialYearPeriodForFinancialYearCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Periods": { "get": { "tags": [ "Financial Year Period" ], "summary": "Get a collection of Financial Year Period resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FinancialYearPeriod->Version | integer | int32 |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| startDate | FinancialYearPeriod->StartDate | string | date |\r\n| endDate | FinancialYearPeriod->EndDate | string | date |\r\n| notes | FinancialYearPeriod->Notes | string | |\r\n| isOpen | FinancialYearPeriod->IsOpen | boolean | |\r\n| createdOn | FinancialYearPeriod->CreatedOn | string | date-time |\r\n| modifiedOn | FinancialYearPeriod->ModifiedOn | string | date-time |\r\n", "operationId": "GetFinancialYearPeriodCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year Period collection", "schema": { "$ref": "#/definitions/GetFinancialYearPeriodCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Periods/Batch/{ids}": { "get": { "tags": [ "Financial Year Period" ], "summary": "Get a collection of Financial Year Period resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| createdByUserId | FinancialYearPeriod->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FinancialYearPeriod->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FinancialYearPeriod->CreatedByUser_FullName | string | |\r\n| createdOn | FinancialYearPeriod->CreatedOn | string | date-time |\r\n| modifiedByUserId | FinancialYearPeriod->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FinancialYearPeriod->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FinancialYearPeriod->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FinancialYearPeriod->ModifiedOn | string | date-time |\r\n| version | FinancialYearPeriod->Version | integer | int32 |\r\n| permissionTreeId | FinancialYearPeriod->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FinancialYearPeriod->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FinancialYearPeriod->PermissionTree_Description | string | |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| endDate | FinancialYearPeriod->EndDate | string | date |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n| isOpen | FinancialYearPeriod->IsOpen | boolean | |\r\n| notes | FinancialYearPeriod->Notes | string | |\r\n| startDate | FinancialYearPeriod->StartDate | string | date |\r\n", "operationId": "BatchGetFinancialYearPeriod", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Financial Year Period id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Financial Year Period collection", "schema": { "$ref": "#/definitions/BatchGetFinancialYearPeriodResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Periods/Batch": { "patch": { "tags": [ "Financial Year Period" ], "summary": "Update a collection of existing Financial Year Period resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| version | FinancialYearPeriod->Version | integer | int32 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| startDate | FinancialYearPeriod->StartDate | string | date |\r\n| endDate | FinancialYearPeriod->EndDate | string | date |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| notes | FinancialYearPeriod->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| startDate | Nullable | False | |\r\n| endDate | Nullable | False | |\r\n| financialYearId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateFinancialYearPeriod", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateFinancialYearPeriodResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Financial Year Period batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/FinancialYears/Periods/CloseFinancialYearPeriod/{financialYearPeriodIds}": { "post": { "tags": [ "Financial Year Period" ], "summary": "Tenant", "description": "", "operationId": "CloseFinancialYearPeriod", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "financialYearPeriodIds", "in": "path", "required": true, "description": "A comma separated list of Financial Year Period id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/{id}": { "get": { "tags": [ "General Ledger" ], "summary": "Get a General Ledger resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | GeneralLedger->Code | string | |\r\n| createdByUserId | GeneralLedger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | GeneralLedger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | GeneralLedger->CreatedByUser_FullName | string | |\r\n| createdOn | GeneralLedger->CreatedOn | string | date-time |\r\n| isActive | GeneralLedger->IsActive | boolean | |\r\n| modifiedByUserId | GeneralLedger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | GeneralLedger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | GeneralLedger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | GeneralLedger->ModifiedOn | string | date-time |\r\n| permissionTreeId | GeneralLedger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | GeneralLedger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | GeneralLedger->PermissionTree_Description | string | |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| description | GeneralLedger->Description | string | |\r\n| notes | GeneralLedger->Notes | string | |\r\n| sequenceNumber | GeneralLedger->SequenceNumber | integer | int32 |\r\n", "operationId": "GetGeneralLedger", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains General Ledger", "schema": { "$ref": "#/definitions/GetGeneralLedgerResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "General Ledger" ], "summary": "Update an existing General Ledger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n| sequenceNumber | GeneralLedger->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateGeneralLedger", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateGeneralLedgerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "General Ledger" ], "summary": "Delete an existing General Ledger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteGeneralLedger", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteGeneralLedgerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers": { "get": { "tags": [ "General Ledger" ], "summary": "Get a collection of General Ledger resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n| sequenceNumber | GeneralLedger->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedger->Notes | string | |\r\n| createdOn | GeneralLedger->CreatedOn | string | date-time |\r\n| modifiedOn | GeneralLedger->ModifiedOn | string | date-time |\r\n", "operationId": "GetGeneralLedgerCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/GetGeneralLedgerCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "General Ledger" ], "summary": "Create a new General Ledger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | GeneralLedger->PermissionTree_Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n| sequenceNumber | GeneralLedger->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateGeneralLedger", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateGeneralLedgerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Lookups/LookupGeneralLedgerChangePermissionTree": { "get": { "tags": [ "General Ledger" ], "summary": "Lookup the permission set for changing the General Ledger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupGeneralLedgerChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/GeneralLedgerChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Lookups/LookupGeneralLedgerInsertPermissionTree": { "get": { "tags": [ "General Ledger" ], "summary": "Lookup the permission set for creating the General Ledger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupGeneralLedgerInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/GeneralLedgerInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Batch/{ids}": { "get": { "tags": [ "General Ledger" ], "summary": "Get a collection of General Ledger resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | GeneralLedger->Code | string | |\r\n| createdByUserId | GeneralLedger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | GeneralLedger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | GeneralLedger->CreatedByUser_FullName | string | |\r\n| createdOn | GeneralLedger->CreatedOn | string | date-time |\r\n| isActive | GeneralLedger->IsActive | boolean | |\r\n| modifiedByUserId | GeneralLedger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | GeneralLedger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | GeneralLedger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | GeneralLedger->ModifiedOn | string | date-time |\r\n| permissionTreeId | GeneralLedger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | GeneralLedger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | GeneralLedger->PermissionTree_Description | string | |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| description | GeneralLedger->Description | string | |\r\n| notes | GeneralLedger->Notes | string | |\r\n| sequenceNumber | GeneralLedger->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetGeneralLedger", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of General Ledger id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains General Ledger collection", "schema": { "$ref": "#/definitions/BatchGetGeneralLedgerResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Batch": { "post": { "tags": [ "General Ledger" ], "summary": "Create a new collection of General Ledger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | GeneralLedger->PermissionTree_Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n| sequenceNumber | GeneralLedger->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateGeneralLedger", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateGeneralLedgerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - General Ledger batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "General Ledger" ], "summary": "Update a collection of existing General Ledger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n| sequenceNumber | GeneralLedger->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateGeneralLedger", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateGeneralLedgerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "General Ledger" ], "summary": "Delete a collection of existing General Ledger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteGeneralLedger", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteGeneralLedgerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/{id}/Active": { "patch": { "tags": [ "General Ledger" ], "summary": "Change the IsActive status for an existing General Ledger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| isActive | GeneralLedger->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeGeneralLedgerIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeGeneralLedgerIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/{id}/PermissionTree": { "patch": { "tags": [ "General Ledger" ], "summary": "Change the PermissionTree for an existing General Ledger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| permissionTreeId | GeneralLedger->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeGeneralLedgerPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeGeneralLedgerPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Batch/Active": { "patch": { "tags": [ "General Ledger" ], "summary": "Change the IsActive status for a collection of existing General Ledger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| isActive | GeneralLedger->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeGeneralLedgerIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeGeneralLedgerIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Batch/PermissionTree": { "patch": { "tags": [ "General Ledger" ], "summary": "Change the PermissionTree status for a collection of existing General Ledger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| version | GeneralLedger->Version | integer | int32 |\r\n| permissionTreeId | GeneralLedger->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeGeneralLedgerPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeGeneralLedgerPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/{id}": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Get a collection of General Ledger Attribute resources for the General Ledger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerAttribute->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | GeneralLedgerAttribute->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | GeneralLedgerAttribute->GeneralLedger_Description | string | |\r\n| createdByUserId | GeneralLedgerAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | GeneralLedgerAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | GeneralLedgerAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | GeneralLedgerAttribute->CreatedOn | string | date-time |\r\n| isActive | GeneralLedgerAttribute->IsActive | boolean | |\r\n| modifiedByUserId | GeneralLedgerAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | GeneralLedgerAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | GeneralLedgerAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | GeneralLedgerAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | GeneralLedgerAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | GeneralLedgerAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | GeneralLedgerAttribute->PermissionTree_Description | string | |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| id | GeneralLedgerAttribute->Id | integer | int64 |\r\n| attributeId | GeneralLedgerAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | GeneralLedgerAttribute->Attribute_Code | string | |\r\n| attributeDescription | GeneralLedgerAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | GeneralLedgerAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | GeneralLedgerAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | GeneralLedgerAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | GeneralLedgerAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | GeneralLedgerAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n", "operationId": "GetGeneralLedgerAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains General Ledger Attribute", "schema": { "$ref": "#/definitions/GetGeneralLedgerAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "General Ledger Attribute" ], "summary": "Update an existing General Ledger Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateGeneralLedgerAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateGeneralLedgerAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "General Ledger Attribute" ], "summary": "Delete an existing General Ledger Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteGeneralLedgerAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteGeneralLedgerAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/{generalLedgerId}/Attributes": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Get a collection of General Ledger Attribute resources for the General Ledger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerAttribute->Id | integer | int64 |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | GeneralLedgerAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | GeneralLedgerAttribute->Attribute_Code | string | |\r\n| attributeDescription | GeneralLedgerAttribute->Attribute_Description | string | |\r\n| attributeDataType | GeneralLedgerAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | GeneralLedgerAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | GeneralLedgerAttribute->PredefinedValue_Value | object | composite |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n| createdOn | GeneralLedgerAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | GeneralLedgerAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetGeneralLedgerAttributeCollectionForGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "generalLedgerId", "in": "path", "required": true, "description": "General Ledger Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger Attribute collection", "schema": { "$ref": "#/definitions/GetGeneralLedgerAttributeCollectionForGeneralLedgerResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Get a collection of General Ledger Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerAttribute->Id | integer | int64 |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| generalLedgerCode | GeneralLedgerAttribute->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | GeneralLedgerAttribute->GeneralLedger_Description | string | |\r\n| attributeId | GeneralLedgerAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | GeneralLedgerAttribute->Attribute_Code | string | |\r\n| attributeDescription | GeneralLedgerAttribute->Attribute_Description | string | |\r\n| attributeDataType | GeneralLedgerAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | GeneralLedgerAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | GeneralLedgerAttribute->PredefinedValue_Value | object | composite |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n| createdOn | GeneralLedgerAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | GeneralLedgerAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetGeneralLedgerAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger Attribute collection", "schema": { "$ref": "#/definitions/GetGeneralLedgerAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "General Ledger Attribute" ], "summary": "Create a new General Ledger Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerAttribute->GeneralLedger_Id | integer | int64 |\r\n| attributeId | GeneralLedgerAttribute->Attribute_Id | integer | int64 |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | GeneralLedgerAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateGeneralLedgerAttribute", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateGeneralLedgerAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/Lookups/LookupGeneralLedgerAttributeAllowedValue": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Lookup the Attribute Allowed Value for the General Ledger Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupGeneralLedgerAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/GeneralLedgerAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/Lookups/LookupGeneralLedgerAttribute": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Lookup the Attribute for the General Ledger Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupGeneralLedgerAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/GeneralLedgerAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/Lookups/LookupGeneralLedgerAttributeGeneralLedger": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Lookup the General Ledger Attribute for the General Ledger Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupGeneralLedgerAttributeGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/GeneralLedgerAttributeGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/Lookups/LookupGeneralLedgerAttributeInsertPermissionTree": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Lookup the permission set for creating the General Ledger Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupGeneralLedgerAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/GeneralLedgerAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/Batch/{ids}": { "get": { "tags": [ "General Ledger Attribute" ], "summary": "Get a collection of General Ledger Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerAttribute->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | GeneralLedgerAttribute->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | GeneralLedgerAttribute->GeneralLedger_Description | string | |\r\n| createdByUserId | GeneralLedgerAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | GeneralLedgerAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | GeneralLedgerAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | GeneralLedgerAttribute->CreatedOn | string | date-time |\r\n| isActive | GeneralLedgerAttribute->IsActive | boolean | |\r\n| modifiedByUserId | GeneralLedgerAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | GeneralLedgerAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | GeneralLedgerAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | GeneralLedgerAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | GeneralLedgerAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | GeneralLedgerAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | GeneralLedgerAttribute->PermissionTree_Description | string | |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| id | GeneralLedgerAttribute->Id | integer | int64 |\r\n| attributeId | GeneralLedgerAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | GeneralLedgerAttribute->Attribute_Code | string | |\r\n| attributeDescription | GeneralLedgerAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | GeneralLedgerAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | GeneralLedgerAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | GeneralLedgerAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | GeneralLedgerAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | GeneralLedgerAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n", "operationId": "BatchGetGeneralLedgerAttribute", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of General Ledger Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains General Ledger Attribute collection", "schema": { "$ref": "#/definitions/BatchGetGeneralLedgerAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/Batch": { "post": { "tags": [ "General Ledger Attribute" ], "summary": "Create a new collection of General Ledger Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerAttribute->GeneralLedger_Id | integer | int64 |\r\n| attributeId | GeneralLedgerAttribute->Attribute_Id | integer | int64 |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | GeneralLedgerAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateGeneralLedgerAttribute", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateGeneralLedgerAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - General Ledger Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "General Ledger Attribute" ], "summary": "Update a collection of existing General Ledger Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerAttribute->Id | integer | int64 |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| value | GeneralLedgerAttribute->Value | object | composite |\r\n| predefinedValueId | GeneralLedgerAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | GeneralLedgerAttribute->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateGeneralLedgerAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateGeneralLedgerAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "General Ledger Attribute" ], "summary": "Delete a collection of existing General Ledger Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerAttribute->Id | integer | int64 |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteGeneralLedgerAttribute", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteGeneralLedgerAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/{id}/Active": { "patch": { "tags": [ "General Ledger Attribute" ], "summary": "Change the IsActive status for an existing General Ledger Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| isActive | GeneralLedgerAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeGeneralLedgerAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeGeneralLedgerAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Attributes/Batch/Active": { "patch": { "tags": [ "General Ledger Attribute" ], "summary": "Change the IsActive status for a collection of existing General Ledger Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerAttribute->Id | integer | int64 |\r\n| version | GeneralLedgerAttribute->Version | integer | int32 |\r\n| isActive | GeneralLedgerAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeGeneralLedgerAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeGeneralLedgerAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/{id}": { "get": { "tags": [ "General Ledger Document" ], "summary": "Get a General Ledger Document resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerDocument->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | GeneralLedgerDocument->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | GeneralLedgerDocument->GeneralLedger_Description | string | |\r\n| isActive | GeneralLedgerDocument->IsActive | boolean | |\r\n| createdByUserId | GeneralLedgerDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | GeneralLedgerDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | GeneralLedgerDocument->CreatedByUser_FullName | string | |\r\n| createdOn | GeneralLedgerDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | GeneralLedgerDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | GeneralLedgerDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | GeneralLedgerDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | GeneralLedgerDocument->ModifiedOn | string | date-time |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| permissionTreeId | GeneralLedgerDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | GeneralLedgerDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | GeneralLedgerDocument->PermissionTree_Description | string | |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| documentRecordId | GeneralLedgerDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | GeneralLedgerDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | GeneralLedgerDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | GeneralLedgerDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | GeneralLedgerDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | GeneralLedgerDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | GeneralLedgerDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | GeneralLedgerDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | GeneralLedgerDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | GeneralLedgerDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | GeneralLedgerDocument->Notes | string | |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetGeneralLedgerDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains General Ledger Document", "schema": { "$ref": "#/definitions/GetGeneralLedgerDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "General Ledger Document" ], "summary": "Update an existing General Ledger Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateGeneralLedgerDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateGeneralLedgerDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "General Ledger Document" ], "summary": "Delete an existing General Ledger Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteGeneralLedgerDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteGeneralLedgerDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Document was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/{id}/Documents": { "get": { "tags": [ "General Ledger Document" ], "summary": "Get a collection of General Ledger Document resources for the General Ledger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | GeneralLedgerDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | GeneralLedgerDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | GeneralLedgerDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | GeneralLedgerDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | GeneralLedgerDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | GeneralLedgerDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | GeneralLedgerDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetGeneralLedgerDocumentCollectionForGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger Document collection", "schema": { "$ref": "#/definitions/GetGeneralLedgerDocumentCollectionForGeneralLedgerResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents": { "get": { "tags": [ "General Ledger Document" ], "summary": "Get a collection of General Ledger Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| generalLedgerId | GeneralLedgerDocument->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | GeneralLedgerDocument->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | GeneralLedgerDocument->GeneralLedger_Description | string | |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | GeneralLedgerDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | GeneralLedgerDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | GeneralLedgerDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | GeneralLedgerDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | GeneralLedgerDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | GeneralLedgerDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | GeneralLedgerDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetGeneralLedgerDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger Document collection", "schema": { "$ref": "#/definitions/GetGeneralLedgerDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "General Ledger Document" ], "summary": "Create a new General Ledger Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerDocument->GeneralLedger_Id | integer | int64 |\r\n| documentRecordId | GeneralLedgerDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | GeneralLedgerDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateGeneralLedgerDocument", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateGeneralLedgerDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Lookups/LookupGeneralLedgerDocumentChangePermissionTree": { "get": { "tags": [ "General Ledger Document" ], "summary": "Lookup the permission set for changing the General Ledger Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupGeneralLedgerDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/GeneralLedgerDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Lookups/LookupGeneralLedgerDocument": { "get": { "tags": [ "General Ledger Document" ], "summary": "General Ledger Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupGeneralLedgerDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/GeneralLedgerDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Lookups/LookupGeneralLedgerDocumentGeneralLedger": { "get": { "tags": [ "General Ledger Document" ], "summary": "Lookup the General Ledger Document for the General Ledger Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupGeneralLedgerDocumentGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/GeneralLedgerDocumentGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Lookups/LookupGeneralLedgerDocumentInsertPermissionTree": { "get": { "tags": [ "General Ledger Document" ], "summary": "Lookup the permission set for creating the General Ledger Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupGeneralLedgerDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/GeneralLedgerDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Batch/{ids}": { "get": { "tags": [ "General Ledger Document" ], "summary": "Get a collection of General Ledger Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerDocument->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | GeneralLedgerDocument->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | GeneralLedgerDocument->GeneralLedger_Description | string | |\r\n| isActive | GeneralLedgerDocument->IsActive | boolean | |\r\n| createdByUserId | GeneralLedgerDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | GeneralLedgerDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | GeneralLedgerDocument->CreatedByUser_FullName | string | |\r\n| createdOn | GeneralLedgerDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | GeneralLedgerDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | GeneralLedgerDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | GeneralLedgerDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | GeneralLedgerDocument->ModifiedOn | string | date-time |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| permissionTreeId | GeneralLedgerDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | GeneralLedgerDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | GeneralLedgerDocument->PermissionTree_Description | string | |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| documentRecordId | GeneralLedgerDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | GeneralLedgerDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | GeneralLedgerDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | GeneralLedgerDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | GeneralLedgerDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | GeneralLedgerDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | GeneralLedgerDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | GeneralLedgerDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | GeneralLedgerDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | GeneralLedgerDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | GeneralLedgerDocument->Notes | string | |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetGeneralLedgerDocument", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of General Ledger Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains General Ledger Document collection", "schema": { "$ref": "#/definitions/BatchGetGeneralLedgerDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Batch": { "post": { "tags": [ "General Ledger Document" ], "summary": "Create a new collection of General Ledger Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| generalLedgerId | GeneralLedgerDocument->GeneralLedger_Id | integer | int64 |\r\n| documentRecordId | GeneralLedgerDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | GeneralLedgerDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateGeneralLedgerDocument", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateGeneralLedgerDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - General Ledger Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "General Ledger Document" ], "summary": "Update a collection of existing General Ledger Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| sequenceNumber | GeneralLedgerDocument->SequenceNumber | integer | int32 |\r\n| notes | GeneralLedgerDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateGeneralLedgerDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateGeneralLedgerDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "General Ledger Document" ], "summary": "Delete a collection of existing General Ledger Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteGeneralLedgerDocument", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteGeneralLedgerDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - General Ledger Document batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/{id}/Active": { "patch": { "tags": [ "General Ledger Document" ], "summary": "Change the IsActive status for an existing General Ledger Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| isActive | GeneralLedgerDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeGeneralLedgerDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeGeneralLedgerDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/{id}/PermissionTree": { "patch": { "tags": [ "General Ledger Document" ], "summary": "Change the PermissionTree for an existing General Ledger Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| permissionTreeId | GeneralLedgerDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeGeneralLedgerDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "General Ledger Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeGeneralLedgerDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Batch/PermissionTree": { "patch": { "tags": [ "General Ledger Document" ], "summary": "Change the PermissionTree status for a collection of existing General Ledger Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| permissionTreeId | GeneralLedgerDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeGeneralLedgerDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeGeneralLedgerDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/FIN/GeneralLedgers/Documents/Batch/Active": { "patch": { "tags": [ "General Ledger Document" ], "summary": "Change the IsActive status for a collection of existing General Ledger Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedgerDocument->Id | integer | int64 |\r\n| version | GeneralLedgerDocument->Version | integer | int32 |\r\n| isActive | GeneralLedgerDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeGeneralLedgerDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeGeneralLedgerDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } } }, "definitions": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "x-nullable": false }, "message": { "title": "message", "type": "string", "x-nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "x-nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "x-nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/definitions/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "x-nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "x-nullable": false, "items": { "$ref": "#/definitions/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "required": [ "permissionId", "permissionTreeId", "propertyPaths" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "required": [ "phrase", "translation", "propertyPaths" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link" }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link" }, "rel": { "type": "string" }, "resource": { "type": "string", "description": "Resource used by link" }, "resourceAction": { "type": "string", "description": "Resource Action used by link" }, "title": { "type": "string", "description": "Title" }, "type": { "description": "Type of link", "$ref": "#/definitions/ResourceLinkType" } } }, "LinkMapping": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string" } } }, "ResourceLinkType": { "type": "string", "description": "", "x-enumNames": [ "Association", "PrimaryAction", "CustomAction", "Collection", "Detail", "Lookup", "Documentation", "Navigation", "Specification" ], "enum": [ "association", "primaryAction", "customAction", "collection", "detail", "lookup", "documentation", "navigation", "specification" ] }, "GetBudgetResourceActionResponse": { "title": "GetBudgetResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetBudgetResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Budget->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Budget->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Budget->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->Site_Description" }, "baseCurrencyId": { "title": "baseCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->BaseCurrency_Id" }, "baseCurrencyCode": { "title": "baseCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->BaseCurrency_Code" }, "baseCurrencyDescription": { "title": "baseCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->BaseCurrency_Description" }, "budgetActualAmount": { "title": "budgetActualAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetActualAmount" }, "budgetActualAmountInBaseCurrency": { "title": "budgetActualAmountInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetActualAmountInBaseCurrency" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Budget->BudgetAmount" }, "budgetAmountInBaseCurrency": { "title": "budgetAmountInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetAmountInBaseCurrency" }, "budgetTemplateId": { "title": "budgetTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->BudgetTemplate_Id" }, "budgetTemplateCode": { "title": "budgetTemplateCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->BudgetTemplate_Code" }, "budgetTemplateDescription": { "title": "budgetTemplateDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->BudgetTemplate_Description" }, "budgetVarianceAmount": { "title": "budgetVarianceAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetVarianceAmount" }, "budgetVarianceAmountInBaseCurrency": { "title": "budgetVarianceAmountInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetVarianceAmountInBaseCurrency" }, "conversionRate": { "title": "conversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Budget->ConversionRate" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Budget->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->Currency_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Description" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Expression" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->FinancialYearPeriod_Description" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->FinancialYearPeriod_FinancialYear_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Budget->SequenceNumber" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Budget->Status", "x-formatSpecifier": "BudgetStatus" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetBudgetCollectionResourceActionResponse": { "title": "GetBudgetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBudgetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBudgetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Code" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_Description" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_FinancialYear_Description" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Budget->BudgetAmount" }, "budgetActualAmount": { "title": "budgetActualAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetActualAmount" }, "budgetVarianceAmount": { "title": "budgetVarianceAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetVarianceAmount" }, "budgetAmountInBaseCurrency": { "title": "budgetAmountInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetAmountInBaseCurrency" }, "budgetActualAmountInBaseCurrency": { "title": "budgetActualAmountInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetActualAmountInBaseCurrency" }, "budgetVarianceAmountInBaseCurrency": { "title": "budgetVarianceAmountInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Budget->BudgetVarianceAmountInBaseCurrency" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Currency_Description" }, "baseCurrencyCode": { "title": "baseCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->BaseCurrency_Code" }, "baseCurrencyDescription": { "title": "baseCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->BaseCurrency_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Budget->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Budget->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetBudgetTemplateLookupResourceActionResponse": { "title": "BudgetBudgetTemplateLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetBudgetTemplateLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetBudgetTemplateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Description" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Expression" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "BudgetTemplate->BudgetAmount" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetChangePermissionTreeLookupResourceActionResponse": { "title": "BudgetChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetCurrencyLookupResourceActionResponse": { "title": "BudgetCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetCurrencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetFinancialYearLookupResourceActionResponse": { "title": "BudgetFinancialYearLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetFinancialYearLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetFinancialYearLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetFinancialYearPeriodLookupResourceActionResponse": { "title": "BudgetFinancialYearPeriodLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetFinancialYearPeriodLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetInsertPermissionTreeLookupResourceActionResponse": { "title": "BudgetInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetSiteLookupResourceActionResponse": { "title": "BudgetSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetSiteLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateBudgetResourceActionRequest": { "title": "CreateBudgetResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateBudgetResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "financialYearPeriodId", "expression", "currencyId", "budgetAmount", "description" ], "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Budget->PermissionTree_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_Id" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Expression" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Budget->Currency_Id" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "Budget->BudgetAmount" }, "budgetTemplateId": { "title": "budgetTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->BudgetTemplate_Id" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->Site_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Budget->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "PatchOperationType": { "type": "string", "description": "", "x-nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/definitions/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "x-nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "x-nullable": true, "example": "BOILER" } } }, "UpdateBudgetResourceActionRequest": { "title": "UpdateBudgetResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Expression" }, { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Budget->Status", "x-formatSpecifier": "BudgetStatus" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Budget->Site_Id" }, { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Description" }, { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Code" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Budget->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Budget->Notes" } ] } } }, "DeleteBudgetResourceActionRequest": { "title": "DeleteBudgetResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetBudgetResourceAction": { "title": "BatchGetBudgetResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Budget entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Budget entities", "items": { "$ref": "#/definitions/GetBudgetResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateBudgetResourceActionRequest": { "title": "BatchCreateBudgetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateBudgetResourceActionRequest" } }, "BatchUpdateBudgetResourceActionRequest": { "title": "BatchUpdateBudgetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateBudgetResourceActionRequest" } }, "BatchDeleteBudgetResourceActionRequest": { "title": "BatchDeleteBudgetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteBudgetResourceActionRequest" } }, "SetBudgetAmountResourceActionRequest": { "title": "SetBudgetAmountResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SetBudgetAmount->BudgetAmount" } ] } } }, "BatchSetBudgetAmountResourceActionRequest": { "title": "BatchSetBudgetAmountResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/SetBudgetAmountResourceActionRequest" } }, "ChangeBudgetPermissionTreeResourceActionRequest": { "title": "ChangeBudgetPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Budget->PermissionTree_Id" } ] } } }, "BatchChangeBudgetPermissionTreeResourceActionRequest": { "title": "BatchChangeBudgetPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeBudgetPermissionTreeResourceActionRequest" } }, "DynamicValueSchema": { "title": "DynamicValueSchema", "type": "object", "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "DynamicValueType", "x-enumNames": [ "String", "Email", "Integer", "Long", "Float", "Currency", "DateTime", "Date", "Time", "Duration", "Boolean" ] }, "value": { "title": "value", "type": "object" } } }, "GetBudgetParameterResourceActionResponse": { "title": "GetBudgetParameterResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetBudgetParameterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetParameter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->PermissionTree_Description" }, "budgetId": { "title": "budgetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetParameter->Budget_Id" }, "budgetBudgetAmount": { "title": "budgetBudgetAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_BudgetAmount" }, "budgetCurrencyId": { "title": "budgetCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_Currency_Id" }, "budgetCurrencyCode": { "title": "budgetCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_Currency_Code" }, "budgetCurrencyDescription": { "title": "budgetCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_Currency_Description" }, "budgetFinancialYearPeriodId": { "title": "budgetFinancialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_Id" }, "budgetFinancialYearPeriodCode": { "title": "budgetFinancialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_Code" }, "budgetFinancialYearPeriodDescription": { "title": "budgetFinancialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_Description" }, "budgetFinancialYearPeriodFinancialYearId": { "title": "budgetFinancialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Id" }, "budgetFinancialYearPeriodFinancialYearCode": { "title": "budgetFinancialYearPeriodFinancialYearCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Code" }, "budgetFinancialYearPeriodFinancialYearDescription": { "title": "budgetFinancialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Notes" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetParameter->ParameterName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetParameter->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetBudgetParameterCollectionResourceActionResponse": { "title": "GetBudgetParameterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBudgetParameterCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBudgetParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetParameter->ParameterName" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetParameter->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetParameter->Value", "x-formatSpecifier": "DynamicValue" }, "budgetId": { "title": "budgetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_Id" }, "budgetFinancialYearPeriodCode": { "title": "budgetFinancialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_Code" }, "budgetFinancialYearPeriodDescription": { "title": "budgetFinancialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_Description" }, "budgetFinancialYearPeriodFinancialYearCode": { "title": "budgetFinancialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Code" }, "budgetFinancialYearPeriodFinancialYearDescription": { "title": "budgetFinancialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetParameter->Budget_FinancialYearPeriod_FinancialYear_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetBudgetParameterForBudgetCollectionResourceActionResponse": { "title": "GetBudgetParameterForBudgetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBudgetParameterForBudgetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBudgetParameterForBudgetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "budgetId": { "title": "budgetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetParameter->Budget_Id" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetParameter->ParameterName" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetParameter->Value", "x-formatSpecifier": "DynamicValue" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetParameter->IsActive" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetParameterChangePermissionTreeLookupResourceActionResponse": { "title": "BudgetParameterChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetParameterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "BudgetParameterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetParameterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetParametersChangeDataTriggerLookupResourceActionResponse": { "title": "BudgetParametersChangeDataTriggerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetParametersChangeDataTriggerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetParametersChangeDataTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Currency_Description" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Budget->BudgetAmount" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_Description" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->FinancialYearPeriod_FinancialYear_Description" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "Budget->Expression" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateBudgetParameterResourceActionRequest": { "title": "CreateBudgetParameterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateBudgetParameterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "parameterName", "value", "budgetId" ], "properties": { "parameterName": { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetParameter->ParameterName" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetParameter->PermissionTree_Id", "x-systemGenerated": true }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetParameter->Value", "x-formatSpecifier": "DynamicValue" }, "budgetId": { "title": "budgetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetParameter->Budget_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetParameter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateBudgetParameterResourceActionRequest": { "title": "UpdateBudgetParameterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetParameter->ParameterName" }, { "title": "value", "format": "composite", "x-nullable": false, "x-propertyPath": "BudgetParameter->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetParameter->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetParameter->Notes" } ] } } }, "DeleteBudgetParameterResourceActionRequest": { "title": "DeleteBudgetParameterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetBudgetParameterResourceAction": { "title": "BatchGetBudgetParameterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Budget Parameter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Budget Parameter entities", "items": { "$ref": "#/definitions/GetBudgetParameterResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateBudgetParameterRequest": { "title": "BatchCreateBudgetParameterRequest", "type": "array", "items": { "$ref": "#/definitions/CreateBudgetParameterResourceActionRequest" } }, "BatchUpdateBudgetParameterResourceActionRequest": { "title": "BatchUpdateBudgetParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateBudgetParameterResourceActionRequest" } }, "BatchDeleteBudgetParameterResourceActionRequest": { "title": "BatchDeleteBudgetParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteBudgetParameterResourceActionRequest" } }, "ChangeBudgetParameterIsActiveResourceActionRequest": { "title": "ChangeBudgetParameterIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetParameter->IsActive" } ] } } }, "ChangeBudgetParameterPermissionTreeResourceActionRequest": { "title": "ChangeBudgetParameterPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetParameter->PermissionTree_Id" } ] } } }, "BatchChangeBudgetParameterIsActiveResourceActionRequest": { "title": "BatchChangeBudgetParameterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeBudgetParameterIsActiveResourceActionRequest" } }, "BatchChangeBudgetParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeBudgetParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeBudgetParameterPermissionTreeResourceActionRequest" } }, "GetBudgetTemplateResourceActionResponse": { "title": "GetBudgetTemplateResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetBudgetTemplateResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetTemplate->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetTemplate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetTemplate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetTemplate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetTemplate->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplate->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->PermissionTree_Description" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "BudgetTemplate->BudgetAmount" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Description" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Expression" }, "isInitialised": { "title": "isInitialised", "type": "boolean", "x-nullable": true, "x-propertyPath": "BudgetTemplate->IsInitialised" }, "isInitialisedReason": { "title": "isInitialisedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BudgetTemplate->IsInitialisedReason", "x-formatSpecifier": "BudgetExpressionIsInitialisedReason" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplate->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetBudgetTemplateCollectionResourceActionResponse": { "title": "GetBudgetTemplateCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBudgetTemplateCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBudgetTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplate->SequenceNumber" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Expression" }, "isInitialised": { "title": "isInitialised", "type": "boolean", "x-nullable": true, "x-propertyPath": "BudgetTemplate->IsInitialised" }, "isInitialisedReason": { "title": "isInitialisedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BudgetTemplate->IsInitialisedReason", "x-formatSpecifier": "BudgetExpressionIsInitialisedReason" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "BudgetTemplate->BudgetAmount" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetTemplate->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetTemplate->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetTemplate->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetTemplateChangePermissionTreeLookupResourceActionResponse": { "title": "BudgetTemplateChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetTemplateChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetTemplateChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetTemplateInsertPermissionTreeLookupResourceActionResponse": { "title": "BudgetTemplateInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetTemplateInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetTemplateInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateBudgetTemplateResourceActionRequest": { "title": "CreateBudgetTemplateResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateBudgetTemplateResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "budgetAmount" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplate->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetTemplate->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetTemplate->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplate->SequenceNumber" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Expression" }, "budgetAmount": { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "BudgetTemplate->BudgetAmount" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateBudgetTemplateResourceActionRequest": { "title": "UpdateBudgetTemplateResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetTemplate->Code" }, { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Expression" }, { "title": "budgetAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "BudgetTemplate->BudgetAmount" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetTemplate->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplate->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplate->Notes" } ] } } }, "DeleteBudgetTemplateResourceActionRequest": { "title": "DeleteBudgetTemplateResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetBudgetTemplateResourceAction": { "title": "BatchGetBudgetTemplateResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Budget Template entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Budget Template entities", "items": { "$ref": "#/definitions/GetBudgetTemplateResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateBudgetTemplateResourceActionRequest": { "title": "BatchCreateBudgetTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateBudgetTemplateResourceActionRequest" } }, "BatchUpdateBudgetTemplateResourceActionRequest": { "title": "BatchUpdateBudgetTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateBudgetTemplateResourceActionRequest" } }, "BatchDeleteBudgetTemplateResourceActionRequest": { "title": "BatchDeleteBudgetTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteBudgetTemplateResourceActionRequest" } }, "ChangeBudgetTemplateIsActiveResourceActionRequest": { "title": "ChangeBudgetTemplateIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetTemplate->IsActive" } ] } } }, "ChangeBudgetTemplatePermissionTreeResourceActionRequest": { "title": "ChangeBudgetTemplatePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplate->PermissionTree_Id" } ] } } }, "BatchChangeBudgetTemplateIsActiveResourceActionRequest": { "title": "BatchChangeBudgetTemplateIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeBudgetTemplateIsActiveResourceActionRequest" } }, "BatchChangeBudgetTemplatePermissionTreeResourceActionRequest": { "title": "BatchChangeBudgetTemplatePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeBudgetTemplatePermissionTreeResourceActionRequest" } }, "GetBudgetTemplateParameterResourceActionResponse": { "title": "GetBudgetTemplateParameterResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetBudgetTemplateParameterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetTemplateParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BudgetTemplateParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->PermissionTree_Description" }, "budgetTemplateId": { "title": "budgetTemplateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Id" }, "budgetTemplateCode": { "title": "budgetTemplateCode", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Code" }, "budgetTemplateDescription": { "title": "budgetTemplateDescription", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Description" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->DataType", "x-formatSpecifier": "DynamicValueType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->Notes" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->ParameterName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetBudgetTemplateParameterCollectionResourceActionResponse": { "title": "GetBudgetTemplateParameterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBudgetTemplateParameterCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBudgetTemplateParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->ParameterName" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->DataType", "x-formatSpecifier": "DynamicValueType" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, "budgetTemplateId": { "title": "budgetTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Id" }, "budgetTemplateCode": { "title": "budgetTemplateCode", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Code" }, "budgetTemplateDescription": { "title": "budgetTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetBudgetTemplateParameterForBudgetTemplateCollectionResourceActionResponse": { "title": "GetBudgetTemplateParameterForBudgetTemplateCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBudgetTemplateParameterForBudgetTemplateCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBudgetTemplateParameterForBudgetTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "budgetTemplateId": { "title": "budgetTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Id" }, "budgetTemplateDescription": { "title": "budgetTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Description" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->DataType", "x-formatSpecifier": "DynamicValueType" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->ParameterName" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->IsActive" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetTemplateParametersChangeDataTriggerLookupResourceActionResponse": { "title": "BudgetTemplateParametersChangeDataTriggerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetTemplateParametersChangeDataTriggerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetTemplateParametersChangeDataTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "BudgetTemplate->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetTemplateParameterChangePermissionTreeLookupResourceActionResponse": { "title": "BudgetTemplateParameterChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetTemplateParameterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetTemplateParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BudgetTemplateParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "BudgetTemplateParameterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "BudgetTemplateParameterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "BudgetTemplateParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateBudgetTemplateParameterResourceActionRequest": { "title": "CreateBudgetTemplateParameterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateBudgetTemplateParameterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "parameterName", "dataType", "value", "budgetTemplateId" ], "properties": { "parameterName": { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->ParameterName" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->DataType", "x-formatSpecifier": "DynamicValueType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->PermissionTree_Id", "x-systemGenerated": true }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "BudgetTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, "budgetTemplateId": { "title": "budgetTemplateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->BudgetTemplate_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateBudgetTemplateParameterResourceActionRequest": { "title": "UpdateBudgetTemplateParameterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->ParameterName" }, { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->DataType", "x-formatSpecifier": "DynamicValueType" }, { "title": "value", "format": "composite", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "BudgetTemplateParameter->Notes" } ] } } }, "DeleteBudgetTemplateParameterResourceActionRequest": { "title": "DeleteBudgetTemplateParameterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetBudgetTemplateParameterResourceAction": { "title": "BatchGetBudgetTemplateParameterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Budget Template Parameter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Budget Template Parameter entities", "items": { "$ref": "#/definitions/GetBudgetTemplateParameterResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateBudgetTemplateParameterRequest": { "title": "BatchCreateBudgetTemplateParameterRequest", "type": "array", "items": { "$ref": "#/definitions/CreateBudgetTemplateParameterResourceActionRequest" } }, "BatchUpdateBudgetTemplateParameterResourceActionRequest": { "title": "BatchUpdateBudgetTemplateParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateBudgetTemplateParameterResourceActionRequest" } }, "BatchDeleteBudgetTemplateParameterResourceActionRequest": { "title": "BatchDeleteBudgetTemplateParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteBudgetTemplateParameterResourceActionRequest" } }, "ChangeBudgetTemplateParameterIsActiveResourceActionRequest": { "title": "ChangeBudgetTemplateParameterIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->IsActive" } ] } } }, "ChangeBudgetTemplateParameterPermissionTreeResourceActionRequest": { "title": "ChangeBudgetTemplateParameterPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "BudgetTemplateParameter->PermissionTree_Id" } ] } } }, "BatchChangeBudgetTemplateParameterIsActiveResourceActionRequest": { "title": "BatchChangeBudgetTemplateParameterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeBudgetTemplateParameterIsActiveResourceActionRequest" } }, "BatchChangeBudgetTemplateParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeBudgetTemplateParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeBudgetTemplateParameterPermissionTreeResourceActionRequest" } }, "GetCostCentreResourceActionResponse": { "title": "GetCostCentreResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostCentreResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostCentre->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentre->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentre->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentre->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentre->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentre->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->PermissionTree_Description" }, "costCentreTypeId": { "title": "costCentreTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentre->CostCentreType_Id" }, "costCentreTypeCode": { "title": "costCentreTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->CostCentreType_Code" }, "costCentreTypeDescription": { "title": "costCentreTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->CostCentreType_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentre->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostCentreCollectionResourceActionResponse": { "title": "GetCostCentreCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostCentreCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostCentreCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentre->SequenceNumber" }, "costCentreTypeId": { "title": "costCentreTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentre->CostCentreType_Id" }, "costCentreTypeCode": { "title": "costCentreTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->CostCentreType_Code" }, "costCentreTypeDescription": { "title": "costCentreTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->CostCentreType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentre->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentre->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreChangePermissionTreeLookupResourceActionResponse": { "title": "CostCentreChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreCostCentreTypeLookupResourceActionResponse": { "title": "CostCentreCostCentreTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreCostCentreTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreCostCentreTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreInsertPermissionTreeLookupResourceActionResponse": { "title": "CostCentreInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostCentreResourceActionRequest": { "title": "CreateCostCentreResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostCentreResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "costCentreTypeId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentre->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentre->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentre->SequenceNumber" }, "costCentreTypeId": { "title": "costCentreTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentre->CostCentreType_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCostCentreResourceActionRequest": { "title": "UpdateCostCentreResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentre->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentre->SequenceNumber" }, { "title": "costCentreTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentre->CostCentreType_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentre->Notes" } ] } } }, "DeleteCostCentreResourceActionRequest": { "title": "DeleteCostCentreResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCostCentreResourceAction": { "title": "BatchGetCostCentreResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Cost Centre entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Cost Centre entities", "items": { "$ref": "#/definitions/GetCostCentreResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostCentreResourceActionRequest": { "title": "BatchCreateCostCentreResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostCentreResourceActionRequest" } }, "BatchUpdateCostCentreResourceActionRequest": { "title": "BatchUpdateCostCentreResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCostCentreResourceActionRequest" } }, "BatchDeleteCostCentreResourceActionRequest": { "title": "BatchDeleteCostCentreResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCostCentreResourceActionRequest" } }, "ChangeCostCentreIsActiveResourceActionRequest": { "title": "ChangeCostCentreIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostCentre->IsActive" } ] } } }, "ChangeCostCentrePermissionTreeResourceActionRequest": { "title": "ChangeCostCentrePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentre->PermissionTree_Id" } ] } } }, "BatchChangeCostCentreIsActiveResourceActionRequest": { "title": "BatchChangeCostCentreIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostCentreIsActiveResourceActionRequest" } }, "BatchChangeCostCentrePermissionTreeResourceActionRequest": { "title": "BatchChangeCostCentrePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostCentrePermissionTreeResourceActionRequest" } }, "GetCostCentreAttributeResourceActionResponse": { "title": "GetCostCentreAttributeResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostCentreAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->CostCentre_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostCentreAttributeCollectionForCostCentreResourceActionResponse": { "title": "GetCostCentreAttributeCollectionForCostCentreResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostCentreAttributeCollectionForCostCentreResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostCentreAttributeCollectionForCostCentreResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetCostCentreAttributeCollectionResourceActionResponse": { "title": "GetCostCentreAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostCentreAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostCentreAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->SequenceNumber" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->CostCentre_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "CostCentreAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreAttributeAttributeLookupResourceActionResponse": { "title": "CostCentreAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreAttributeCostCentreLookupResourceActionResponse": { "title": "CostCentreAttributeCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreAttributeCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreAttributeCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "CostCentreAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostCentreAttributeResourceActionRequest": { "title": "CreateCostCentreAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostCentreAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "costCentreId", "attributeId" ], "properties": { "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->CostCentre_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostCentreAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCostCentreAttributeResourceActionRequest": { "title": "UpdateCostCentreAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreAttribute->Notes" } ] } } }, "DeleteCostCentreAttributeResourceActionRequest": { "title": "DeleteCostCentreAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCostCentreAttributeResourceAction": { "title": "BatchGetCostCentreAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Cost Centre Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Cost Centre Attribute entities", "items": { "$ref": "#/definitions/GetCostCentreAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostCentreAttributeResourceActionRequest": { "title": "BatchCreateCostCentreAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostCentreAttributeResourceActionRequest" } }, "BatchUpdateCostCentreAttributeResourceActionRequest": { "title": "BatchUpdateCostCentreAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCostCentreAttributeResourceActionRequest" } }, "BatchDeleteCostCentreAttributeResourceActionRequest": { "title": "BatchDeleteCostCentreAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCostCentreAttributeResourceActionRequest" } }, "ChangeCostCentreAttributeIsActiveResourceActionRequest": { "title": "ChangeCostCentreAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostCentreAttribute->IsActive" } ] } } }, "BatchChangeCostCentreAttributeIsActiveResourceActionRequest": { "title": "BatchChangeCostCentreAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostCentreAttributeIsActiveResourceActionRequest" } }, "GetCostCentreDocumentResourceActionResponse": { "title": "GetCostCentreDocumentResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostCentreDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreDocument->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->CostCentre_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "CostCentreDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostCentreDocumentCollectionForCostCentreResourceActionResponse": { "title": "GetCostCentreDocumentCollectionForCostCentreResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostCentreDocumentCollectionForCostCentreResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostCentreDocumentCollectionForCostCentreResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetCostCentreDocumentCollectionResourceActionResponse": { "title": "GetCostCentreDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostCentreDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostCentreDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreDocument->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreDocument->CostCentre_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "CostCentreDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreDocumentCostCentreLookupResourceActionResponse": { "title": "CostCentreDocumentCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreDocumentCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreDocumentCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreDocumentDocumentLookupResourceActionResponse": { "title": "CostCentreDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "CostCentreDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostCentreDocumentResourceActionRequest": { "title": "CreateCostCentreDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostCentreDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "costCentreId", "documentRecordId" ], "properties": { "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreDocument->CostCentre_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCostCentreDocumentResourceActionRequest": { "title": "UpdateCostCentreDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreDocument->Notes" } ] } } }, "DeleteCostCentreDocumentResourceActionRequest": { "title": "DeleteCostCentreDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCostCentreDocumentResourceAction": { "title": "BatchGetCostCentreDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Cost Centre Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Cost Centre Document entities", "items": { "$ref": "#/definitions/GetCostCentreDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostCentreDocumentResourceActionRequest": { "title": "BatchCreateCostCentreDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostCentreDocumentResourceActionRequest" } }, "BatchUpdateCostCentreDocumentResourceActionRequest": { "title": "BatchUpdateCostCentreDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCostCentreDocumentResourceActionRequest" } }, "BatchDeleteCostCentreDocumentResourceActionRequest": { "title": "BatchDeleteCostCentreDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCostCentreDocumentResourceActionRequest" } }, "ChangeCostCentreDocumentIsActiveResourceActionRequest": { "title": "ChangeCostCentreDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostCentreDocument->IsActive" } ] } } }, "ChangeCostCentreDocumentPermissionTreeResourceActionRequest": { "title": "ChangeCostCentreDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreDocument->PermissionTree_Id" } ] } } }, "BatchChangeCostCentreDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeCostCentreDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostCentreDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeCostCentreDocumentIsActiveResourceActionRequest": { "title": "BatchChangeCostCentreDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostCentreDocumentIsActiveResourceActionRequest" } }, "GetCostCentreTypeResourceActionResponse": { "title": "GetCostCentreTypeResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostCentreTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreType->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostCentreType->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostCentreType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostCentreTypeCollectionResourceActionResponse": { "title": "GetCostCentreTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostCentreTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostCentreTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentreType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostCentreType->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreTypeChangePermissionTreeLookupResourceActionResponse": { "title": "CostCentreTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostCentreTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "CostCentreTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostCentreTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostCentreTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostCentreTypeResourceActionRequest": { "title": "CreateCostCentreTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostCentreTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentreType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentreType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCostCentreTypeResourceActionRequest": { "title": "UpdateCostCentreTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentreType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostCentreType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostCentreType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostCentreType->Notes" } ] } } }, "DeleteCostCentreTypeResourceActionRequest": { "title": "DeleteCostCentreTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCostCentreTypeResourceAction": { "title": "BatchGetCostCentreTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Cost Centre Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Cost Centre Type entities", "items": { "$ref": "#/definitions/GetCostCentreTypeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostCentreTypeResourceActionRequest": { "title": "BatchCreateCostCentreTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostCentreTypeResourceActionRequest" } }, "BatchUpdateCostCentreTypeResourceActionRequest": { "title": "BatchUpdateCostCentreTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCostCentreTypeResourceActionRequest" } }, "BatchDeleteCostCentreTypeResourceActionRequest": { "title": "BatchDeleteCostCentreTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCostCentreTypeResourceActionRequest" } }, "ChangeCostCentreTypeIsActiveResourceActionRequest": { "title": "ChangeCostCentreTypeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostCentreType->IsActive" } ] } } }, "ChangeCostCentreTypePermissionTreeResourceActionRequest": { "title": "ChangeCostCentreTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostCentreType->PermissionTree_Id" } ] } } }, "BatchChangeCostCentreTypeIsActiveResourceActionRequest": { "title": "BatchChangeCostCentreTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostCentreTypeIsActiveResourceActionRequest" } }, "BatchChangeCostCentreTypePermissionTreeResourceActionRequest": { "title": "BatchChangeCostCentreTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostCentreTypePermissionTreeResourceActionRequest" } }, "GetCostElementResourceActionResponse": { "title": "GetCostElementResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostElementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElement->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostElement->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElement->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElement->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElement->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostElementCollectionResourceActionResponse": { "title": "GetCostElementCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostElementCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostElementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElement->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElement->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElement->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementChangePermissionTreeLookupResourceActionResponse": { "title": "CostElementChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementInsertPermissionTreeLookupResourceActionResponse": { "title": "CostElementInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostElementResourceActionRequest": { "title": "CreateCostElementResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostElementResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElement->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostElement->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElement->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCostElementResourceActionRequest": { "title": "UpdateCostElementResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostElement->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CostElement->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElement->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElement->Notes" } ] } } }, "DeleteCostElementResourceActionRequest": { "title": "DeleteCostElementResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCostElementResourceAction": { "title": "BatchGetCostElementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Cost Element entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Cost Element entities", "items": { "$ref": "#/definitions/GetCostElementResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostElementResourceActionRequest": { "title": "BatchCreateCostElementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostElementResourceActionRequest" } }, "BatchUpdateCostElementResourceActionRequest": { "title": "BatchUpdateCostElementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCostElementResourceActionRequest" } }, "BatchDeleteCostElementResourceActionRequest": { "title": "BatchDeleteCostElementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCostElementResourceActionRequest" } }, "ChangeCostElementIsActiveResourceActionRequest": { "title": "ChangeCostElementIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostElement->IsActive" } ] } } }, "ChangeCostElementPermissionTreeResourceActionRequest": { "title": "ChangeCostElementPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElement->PermissionTree_Id" } ] } } }, "BatchChangeCostElementIsActiveResourceActionRequest": { "title": "BatchChangeCostElementIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostElementIsActiveResourceActionRequest" } }, "BatchChangeCostElementPermissionTreeResourceActionRequest": { "title": "BatchChangeCostElementPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostElementPermissionTreeResourceActionRequest" } }, "GetCostElementAttributeResourceActionResponse": { "title": "GetCostElementAttributeResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostElementAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementAttribute->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->CostElement_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "CostElementAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostElementAttributeCollectionForCostElementResourceActionResponse": { "title": "GetCostElementAttributeCollectionForCostElementResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostElementAttributeCollectionForCostElementResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostElementAttributeCollectionForCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetCostElementAttributeCollectionResourceActionResponse": { "title": "GetCostElementAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostElementAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostElementAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementAttribute->SequenceNumber" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementAttribute->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementAttribute->CostElement_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "CostElementAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementAttributeAttributeLookupResourceActionResponse": { "title": "CostElementAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementAttributeCostElementLookupResourceActionResponse": { "title": "CostElementAttributeCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementAttributeCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementAttributeCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "CostElementAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostElementAttributeResourceActionRequest": { "title": "CreateCostElementAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostElementAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "costElementId", "attributeId" ], "properties": { "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementAttribute->CostElement_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "CostElementAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCostElementAttributeResourceActionRequest": { "title": "UpdateCostElementAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementAttribute->Notes" } ] } } }, "DeleteCostElementAttributeResourceActionRequest": { "title": "DeleteCostElementAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCostElementAttributeResourceAction": { "title": "BatchGetCostElementAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Cost Element Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Cost Element Attribute entities", "items": { "$ref": "#/definitions/GetCostElementAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostElementAttributeResourceActionRequest": { "title": "BatchCreateCostElementAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostElementAttributeResourceActionRequest" } }, "BatchUpdateCostElementAttributeResourceActionRequest": { "title": "BatchUpdateCostElementAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCostElementAttributeResourceActionRequest" } }, "BatchDeleteCostElementAttributeResourceActionRequest": { "title": "BatchDeleteCostElementAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCostElementAttributeResourceActionRequest" } }, "ChangeCostElementAttributeIsActiveResourceActionRequest": { "title": "ChangeCostElementAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostElementAttribute->IsActive" } ] } } }, "BatchChangeCostElementAttributeIsActiveResourceActionRequest": { "title": "BatchChangeCostElementAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostElementAttributeIsActiveResourceActionRequest" } }, "GetCostElementDocumentResourceActionResponse": { "title": "GetCostElementDocumentResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostElementDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementDocument->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->CostElement_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "CostElementDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostElementDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostElementDocumentCollectionForCostElementResourceActionResponse": { "title": "GetCostElementDocumentCollectionForCostElementResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostElementDocumentCollectionForCostElementResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostElementDocumentCollectionForCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetCostElementDocumentCollectionResourceActionResponse": { "title": "GetCostElementDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostElementDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostElementDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementDocument->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementDocument->CostElement_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostElementDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "CostElementDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementDocumentCostElementLookupResourceActionResponse": { "title": "CostElementDocumentCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementDocumentCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementDocumentCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementDocumentDocumentLookupResourceActionResponse": { "title": "CostElementDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostElementDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "CostElementDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostElementDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostElementDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostElementDocumentResourceActionRequest": { "title": "CreateCostElementDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostElementDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "costElementId", "documentRecordId" ], "properties": { "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementDocument->CostElement_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCostElementDocumentResourceActionRequest": { "title": "UpdateCostElementDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CostElementDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CostElementDocument->Notes" } ] } } }, "DeleteCostElementDocumentResourceActionRequest": { "title": "DeleteCostElementDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCostElementDocumentResourceAction": { "title": "BatchGetCostElementDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Cost Element Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Cost Element Document entities", "items": { "$ref": "#/definitions/GetCostElementDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostElementDocumentResourceActionRequest": { "title": "BatchCreateCostElementDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostElementDocumentResourceActionRequest" } }, "BatchUpdateCostElementDocumentResourceActionRequest": { "title": "BatchUpdateCostElementDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCostElementDocumentResourceActionRequest" } }, "BatchDeleteCostElementDocumentResourceActionRequest": { "title": "BatchDeleteCostElementDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCostElementDocumentResourceActionRequest" } }, "ChangeCostElementDocumentIsActiveResourceActionRequest": { "title": "ChangeCostElementDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "CostElementDocument->IsActive" } ] } } }, "ChangeCostElementDocumentPermissionTreeResourceActionRequest": { "title": "ChangeCostElementDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostElementDocument->PermissionTree_Id" } ] } } }, "BatchChangeCostElementDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeCostElementDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostElementDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeCostElementDocumentIsActiveResourceActionRequest": { "title": "BatchChangeCostElementDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCostElementDocumentIsActiveResourceActionRequest" } }, "GetCostingResourceActionResponse": { "title": "GetCostingResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostingResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Costing->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Costing->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->Site_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetConsumptionId": { "title": "assetConsumptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->AssetConsumption_Id" }, "assetConsumptionAssetId": { "title": "assetConsumptionAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->AssetConsumption_Asset_Id" }, "assetConsumptionAssetCode": { "title": "assetConsumptionAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetConsumption_Asset_Code" }, "assetConsumptionAssetDescription": { "title": "assetConsumptionAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetConsumption_Asset_Description" }, "assetConsumptionAssetIsMsi": { "title": "assetConsumptionAssetIsMsi", "type": "boolean", "x-nullable": true, "x-propertyPath": "Costing->AssetConsumption_Asset_IsMsi" }, "assetConsumptionAssetRecordType": { "title": "assetConsumptionAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->AssetConsumption_Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "baseCurrencyId": { "title": "baseCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->BaseCurrency_Id" }, "baseCurrencyCode": { "title": "baseCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->BaseCurrency_Code" }, "conversionRateId": { "title": "conversionRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->ConversionRate_Id" }, "conversionRateSourceCurrencyId": { "title": "conversionRateSourceCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->ConversionRate_SourceCurrency_Id" }, "conversionRateSourceCurrencyCode": { "title": "conversionRateSourceCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->ConversionRate_SourceCurrency_Code" }, "conversionRateTargetCurrencyId": { "title": "conversionRateTargetCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->ConversionRate_TargetCurrency_Id" }, "conversionRateTargetCurrencyCode": { "title": "conversionRateTargetCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->ConversionRate_TargetCurrency_Code" }, "conversionRateValue": { "title": "conversionRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->ConversionRateValue" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Description" }, "evaluatedForBudget": { "title": "evaluatedForBudget", "type": "boolean", "x-nullable": true, "x-propertyPath": "Costing->EvaluatedForBudget" }, "expenseType": { "title": "expenseType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Costing->ExpenseType", "x-formatSpecifier": "ExpenseType" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->FinancialYearPeriod_Description" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->FinancialYearPeriod_FinancialYear_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Description" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Costing->Origin", "x-formatSpecifier": "Origin" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity" }, "requisitionItemTransactionId": { "title": "requisitionItemTransactionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->RequisitionItemTransaction_Id" }, "requisitionItemTransactionRequisitionItemId": { "title": "requisitionItemTransactionRequisitionItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->RequisitionItemTransaction_RequisitionItem_Id" }, "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareId": { "title": "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Id" }, "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareCode": { "title": "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Code" }, "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareDescription": { "title": "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->SiteCurrency_Code" }, "totalCostInBaseCurrency": { "title": "totalCostInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInBaseCurrency" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Costing->TransactedOn" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->UnitOfMeasurement_Description" }, "unitPriceInSiteCurrency": { "title": "unitPriceInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->UnitPriceInSiteCurrency" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrder_Description" }, "workOrderAssetId": { "title": "workOrderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Id" }, "workOrderAssetCode": { "title": "workOrderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Code" }, "workOrderAssetDescription": { "title": "workOrderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Description" }, "workOrderAssetRecordType": { "title": "workOrderAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "workOrderTaskAdHocCostId": { "title": "workOrderTaskAdHocCostId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_Id" }, "workOrderTaskAdHocCostCode": { "title": "workOrderTaskAdHocCostCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_Code" }, "workOrderTaskAdHocCostDescription": { "title": "workOrderTaskAdHocCostDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_Description" }, "workOrderTaskAdHocCostTotalCost": { "title": "workOrderTaskAdHocCostTotalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_TotalCost" }, "workOrderTaskAdHocCostTransactedOn": { "title": "workOrderTaskAdHocCostTransactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_TransactedOn" }, "workOrderTaskAssetId": { "title": "workOrderTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Id" }, "workOrderTaskAssetCode": { "title": "workOrderTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Code" }, "workOrderTaskAssetDescription": { "title": "workOrderTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Description" }, "workOrderTaskAssetRecordType": { "title": "workOrderTaskAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "workOrderTaskResourceId": { "title": "workOrderTaskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Id" }, "workOrderTaskResourceResourceId": { "title": "workOrderTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_Id" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_Code" }, "workOrderTaskResourceResourceDescription": { "title": "workOrderTaskResourceResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_Description" }, "workOrderTaskResourceResourceResourceType": { "title": "workOrderTaskResourceResourceResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "workOrderTaskResourceUsageId": { "title": "workOrderTaskResourceUsageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResourceUsage_Id" }, "workOrderTaskResourceUsageCostInResourceCurrency": { "title": "workOrderTaskResourceUsageCostInResourceCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResourceUsage_CostInResourceCurrency" }, "workOrderTaskResourceUsageCostInWorkOrderCurrency": { "title": "workOrderTaskResourceUsageCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResourceUsage_CostInWorkOrderCurrency" }, "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskSpare_Id" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskSpare_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostingCollectionResourceActionResponse": { "title": "GetCostingCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostingCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostingCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrder_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "workOrderAssetId": { "title": "workOrderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Id" }, "workOrderAssetCode": { "title": "workOrderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Code" }, "workOrderAssetDescription": { "title": "workOrderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Description" }, "workOrderAssetRecordType": { "title": "workOrderAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "workOrderTaskAssetId": { "title": "workOrderTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Id" }, "workOrderTaskAssetCode": { "title": "workOrderTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Code" }, "workOrderTaskAssetDescription": { "title": "workOrderTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Description" }, "workOrderTaskAssetRecordType": { "title": "workOrderTaskAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskSpare_Id" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrderTaskSpare_Description" }, "expenseType": { "title": "expenseType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Costing->ExpenseType", "x-formatSpecifier": "ExpenseType" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Costing->Origin", "x-formatSpecifier": "Origin" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Costing->TransactedOn" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity" }, "unitPriceInSiteCurrency": { "title": "unitPriceInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->UnitPriceInSiteCurrency" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "totalCostInBaseCurrency": { "title": "totalCostInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInBaseCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->UnitOfMeasurement_Description" }, "requisitionItemTransactionId": { "title": "requisitionItemTransactionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->RequisitionItemTransaction_Id" }, "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareCode": { "title": "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Code" }, "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareDescription": { "title": "requisitionItemTransactionRequisitionItemWorkOrderTaskSpareDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->RequisitionItemTransaction_RequisitionItem_WorkOrderTaskSpare_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->SiteCurrency_Code" }, "baseCurrencyId": { "title": "baseCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->BaseCurrency_Id" }, "baseCurrencyCode": { "title": "baseCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->BaseCurrency_Code" }, "workOrderTaskResourceId": { "title": "workOrderTaskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Id" }, "workOrderTaskResourceResourceId": { "title": "workOrderTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_Id" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_Code" }, "workOrderTaskResourceResourceDescription": { "title": "workOrderTaskResourceResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_Description" }, "workOrderTaskAdHocCostId": { "title": "workOrderTaskAdHocCostId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_Id" }, "workOrderTaskAdHocCostDescription": { "title": "workOrderTaskAdHocCostDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_Description" }, "conversionRateId": { "title": "conversionRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->ConversionRate_Id" }, "conversionRateValue": { "title": "conversionRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->ConversionRateValue" }, "workOrderTaskResourceUsageId": { "title": "workOrderTaskResourceUsageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskResourceUsage_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostingChangePermissionTreeLookupResourceActionResponse": { "title": "CostingChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostingChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostingChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CostingInsertPermissionTreeLookupResourceActionResponse": { "title": "CostingInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CostingInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CostingInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCostingResourceActionRequest": { "title": "CreateCostingResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCostingResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "generalLedgerId", "costCentreId", "costElementId", "unitPriceInSiteCurrency", "description" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Asset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->PermissionTree_Id" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->Site_Id" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrder_Id" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->FinancialYearPeriod_Id", "x-systemGenerated": true }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Id" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Id" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->UnitOfMeasurement_Id" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Costing->TransactedOn" }, "expenseType": { "title": "expenseType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Costing->ExpenseType", "x-formatSpecifier": "ExpenseType" }, "unitPriceInSiteCurrency": { "title": "unitPriceInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->UnitPriceInSiteCurrency" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Costing->Description" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchGetCostingResourceAction": { "title": "BatchGetCostingResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Costing entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Costing entities", "items": { "$ref": "#/definitions/GetCostingResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCostingResourceActionRequest": { "title": "BatchCreateCostingResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCostingResourceActionRequest" } }, "GetCostingBudgetResourceActionResponse": { "title": "GetCostingBudgetResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCostingBudgetResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostingBudget->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostingBudget->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostingBudget->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostingBudget->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostingBudget->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->PermissionTree_Description" }, "budgetId": { "title": "budgetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostingBudget->Budget_Id" }, "budgetBudgetAmount": { "title": "budgetBudgetAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_BudgetAmount" }, "budgetCurrencyId": { "title": "budgetCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_Currency_Id" }, "budgetCurrencyCode": { "title": "budgetCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_Currency_Code" }, "budgetCurrencyDescription": { "title": "budgetCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_Currency_Description" }, "budgetFinancialYearPeriodId": { "title": "budgetFinancialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_FinancialYearPeriod_Id" }, "budgetFinancialYearPeriodCode": { "title": "budgetFinancialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_FinancialYearPeriod_Code" }, "budgetFinancialYearPeriodDescription": { "title": "budgetFinancialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_FinancialYearPeriod_Description" }, "budgetFinancialYearPeriodFinancialYearId": { "title": "budgetFinancialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Id" }, "budgetFinancialYearPeriodFinancialYearCode": { "title": "budgetFinancialYearPeriodFinancialYearCode", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Code" }, "budgetFinancialYearPeriodFinancialYearDescription": { "title": "budgetFinancialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_FinancialYearPeriod_FinancialYear_Description" }, "costingId": { "title": "costingId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CostingBudget->Costing_Id" }, "costingDescription": { "title": "costingDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CostingBudget->Costing_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostingBudgetCollectionResourceActionResponse": { "title": "GetCostingBudgetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostingBudgetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostingBudgetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "costingId": { "title": "costingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostingBudget->Costing_Id" }, "costingDescription": { "title": "costingDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CostingBudget->Costing_Description" }, "budgetId": { "title": "budgetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CostingBudget->Budget_Id" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostingBudget->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CostingBudget->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BatchGetCostingBudgetResourceAction": { "title": "BatchGetCostingBudgetResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Costing Budget entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Costing Budget entities", "items": { "$ref": "#/definitions/GetCostingBudgetResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCurrencyResourceActionResponse": { "title": "GetCurrencyResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCurrencyResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Currency->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Currency->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Currency->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Currency->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Currency->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Currency->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" }, "isoCode": { "title": "isoCode", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->IsoCode" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Currency->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCurrencyCollectionResourceActionResponse": { "title": "GetCurrencyCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCurrencyCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCurrencyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Currency->SequenceNumber" }, "isoCode": { "title": "isoCode", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->IsoCode" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Currency->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Currency->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Currency->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CurrencyChangePermissionTreeLookupResourceActionResponse": { "title": "CurrencyChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CurrencyChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CurrencyChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CurrencyInsertPermissionTreeLookupResourceActionResponse": { "title": "CurrencyInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CurrencyInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CurrencyInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCurrencyResourceActionRequest": { "title": "CreateCurrencyResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCurrencyResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "isoCode" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Currency->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Currency->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Currency->SequenceNumber" }, "isoCode": { "title": "isoCode", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Currency->IsoCode" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCurrencyResourceActionRequest": { "title": "UpdateCurrencyResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Currency->Code" }, { "title": "isoCode", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Currency->IsoCode" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Currency->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Currency->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Currency->Notes" } ] } } }, "DeleteCurrencyResourceActionRequest": { "title": "DeleteCurrencyResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetCurrencyResourceAction": { "title": "BatchGetCurrencyResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Currency entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Currency entities", "items": { "$ref": "#/definitions/GetCurrencyResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCurrencyResourceActionRequest": { "title": "BatchCreateCurrencyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCurrencyResourceActionRequest" } }, "BatchUpdateCurrencyResourceActionRequest": { "title": "BatchUpdateCurrencyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCurrencyResourceActionRequest" } }, "BatchDeleteCurrencyResourceActionRequest": { "title": "BatchDeleteCurrencyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCurrencyResourceActionRequest" } }, "ChangeCurrencyIsActiveResourceActionRequest": { "title": "ChangeCurrencyIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Currency->IsActive" } ] } } }, "ChangeCurrencyPermissionTreeResourceActionRequest": { "title": "ChangeCurrencyPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Currency->PermissionTree_Id" } ] } } }, "BatchChangeCurrencyIsActiveResourceActionRequest": { "title": "BatchChangeCurrencyIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCurrencyIsActiveResourceActionRequest" } }, "BatchChangeCurrencyPermissionTreeResourceActionRequest": { "title": "BatchChangeCurrencyPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCurrencyPermissionTreeResourceActionRequest" } }, "GetCurrencyRateResourceActionResponse": { "title": "GetCurrencyRateResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetCurrencyRateResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CurrencyRate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CurrencyRate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->ModifiedOn" }, "allowedVariancePercentage": { "title": "allowedVariancePercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->AllowedVariancePercentage" }, "applicableFrom": { "title": "applicableFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->ApplicableFrom" }, "applicableTo": { "title": "applicableTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->ApplicableTo", "x-NullExpression": "CurrencyRate->IsLatest eq false" }, "appliedConversionRate": { "title": "appliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->AppliedConversionRate" }, "conversionType": { "title": "conversionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CurrencyRate->ConversionType", "x-formatSpecifier": "CurrencyRateConversionType" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": false, "x-propertyPath": "CurrencyRate->IsLatest" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->Notes" }, "sourceCurrencyId": { "title": "sourceCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CurrencyRate->SourceCurrency_Id" }, "sourceCurrencyCode": { "title": "sourceCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->SourceCurrency_Code" }, "sourceCurrencyDescription": { "title": "sourceCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->SourceCurrency_Description" }, "targetCurrencyId": { "title": "targetCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CurrencyRate->TargetCurrency_Id" }, "targetCurrencyCode": { "title": "targetCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->TargetCurrency_Code" }, "targetCurrencyDescription": { "title": "targetCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->TargetCurrency_Description" }, "userSuppliedConversionRate": { "title": "userSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->UserSuppliedConversionRate" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCurrencyRateCollectionResourceActionResponse": { "title": "GetCurrencyRateCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCurrencyRateCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCurrencyRateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "allowedVariancePercentage": { "title": "allowedVariancePercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->AllowedVariancePercentage" }, "applicableFrom": { "title": "applicableFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->ApplicableFrom" }, "applicableTo": { "title": "applicableTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->ApplicableTo", "x-NullExpression": "CurrencyRate->IsLatest eq false" }, "appliedConversionRate": { "title": "appliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->AppliedConversionRate" }, "conversionType": { "title": "conversionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CurrencyRate->ConversionType", "x-formatSpecifier": "CurrencyRateConversionType" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": false, "x-propertyPath": "CurrencyRate->IsLatest" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->Notes" }, "sourceCurrencyId": { "title": "sourceCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CurrencyRate->SourceCurrency_Id" }, "sourceCurrencyCode": { "title": "sourceCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->SourceCurrency_Code" }, "sourceCurrencyDescription": { "title": "sourceCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->SourceCurrency_Description" }, "targetCurrencyId": { "title": "targetCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CurrencyRate->TargetCurrency_Id" }, "targetCurrencyCode": { "title": "targetCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->TargetCurrency_Code" }, "targetCurrencyDescription": { "title": "targetCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->TargetCurrency_Description" }, "userSuppliedConversionRate": { "title": "userSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->UserSuppliedConversionRate" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetCurrencyRateForCurrencyCollectionResourceActionResponse": { "title": "GetCurrencyRateForCurrencyCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCurrencyRateForCurrencyCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCurrencyRateForCurrencyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "allowedVariancePercentage": { "title": "allowedVariancePercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->AllowedVariancePercentage" }, "applicableFrom": { "title": "applicableFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->ApplicableFrom" }, "applicableTo": { "title": "applicableTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CurrencyRate->ApplicableTo", "x-NullExpression": "CurrencyRate->IsLatest eq false" }, "appliedConversionRate": { "title": "appliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->AppliedConversionRate" }, "conversionType": { "title": "conversionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CurrencyRate->ConversionType", "x-formatSpecifier": "CurrencyRateConversionType" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": false, "x-propertyPath": "CurrencyRate->IsLatest" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->Notes" }, "sourceCurrencyId": { "title": "sourceCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CurrencyRate->SourceCurrency_Id" }, "sourceCurrencyCode": { "title": "sourceCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->SourceCurrency_Code" }, "sourceCurrencyDescription": { "title": "sourceCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->SourceCurrency_Description" }, "targetCurrencyId": { "title": "targetCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CurrencyRate->TargetCurrency_Id" }, "targetCurrencyCode": { "title": "targetCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->TargetCurrency_Code" }, "targetCurrencyDescription": { "title": "targetCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CurrencyRate->TargetCurrency_Description" }, "userSuppliedConversionRate": { "title": "userSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "CurrencyRate->UserSuppliedConversionRate" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CurrencyRateSourceCurrencyLookupResourceActionResponse": { "title": "CurrencyRateSourceCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CurrencyRateSourceCurrencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CurrencyRateSourceCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CurrencyRateTargetCurrencyLookupResourceActionResponse": { "title": "CurrencyRateTargetCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "CurrencyRateTargetCurrencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "CurrencyRateTargetCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateCurrencyRateResourceActionRequest": { "title": "CreateCurrencyRateResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCurrencyRateResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "targetCurrencyId": { "title": "targetCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CurrencyRate->TargetCurrency_Id" }, "sourceCurrencyId": { "title": "sourceCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CurrencyRate->SourceCurrency_Id" }, "conversionType": { "title": "conversionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CurrencyRate->ConversionType", "x-formatSpecifier": "CurrencyRateConversionType" }, "userSuppliedConversionRate": { "title": "userSuppliedConversionRate", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "CurrencyRate->UserSuppliedConversionRate" }, "allowedVariancePercentage": { "title": "allowedVariancePercentage", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "CurrencyRate->AllowedVariancePercentage" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCurrencyRateResourceActionRequest": { "title": "UpdateCurrencyRateResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CurrencyRate->Notes" } ] } } }, "BatchGetCurrencyRateResourceAction": { "title": "BatchGetCurrencyRateResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Currency Rate entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Currency Rate entities", "items": { "$ref": "#/definitions/GetCurrencyRateResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateCurrencyRateResourceActionRequest": { "title": "BatchCreateCurrencyRateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCurrencyRateResourceActionRequest" } }, "BatchUpdateCurrencyRateResourceActionRequest": { "title": "BatchUpdateCurrencyRateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCurrencyRateResourceActionRequest" } }, "GetFinancialYearResourceActionResponse": { "title": "GetFinancialYearResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetFinancialYearResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYear->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYear->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYear->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYear->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FinancialYear->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->Description" }, "isOpen": { "title": "isOpen", "type": "boolean", "x-nullable": false, "x-propertyPath": "FinancialYear->IsOpen" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->Notes" }, "startDate": { "title": "startDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYear->StartDate" }, "endDate": { "title": "endDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYear->EndDate" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFinancialYearCollectionResourceActionResponse": { "title": "GetFinancialYearCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFinancialYearCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFinancialYearCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->Description" }, "startDate": { "title": "startDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYear->StartDate" }, "endDate": { "title": "endDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYear->EndDate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->Notes" }, "isOpen": { "title": "isOpen", "type": "boolean", "x-nullable": false, "x-propertyPath": "FinancialYear->IsOpen" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYear->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYear->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FinancialYearChangePermissionTreeLookupResourceActionResponse": { "title": "FinancialYearChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FinancialYearChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FinancialYearChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FinancialYearInsertPermissionTreeLookupResourceActionResponse": { "title": "FinancialYearInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FinancialYearInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FinancialYearInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateFinancialYearResourceActionRequest": { "title": "CreateFinancialYearResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFinancialYearResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "startDate", "endDate" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FinancialYear->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FinancialYear->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FinancialYear->Description" }, "startDate": { "title": "startDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYear->StartDate" }, "endDate": { "title": "endDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYear->EndDate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFinancialYearResourceActionRequest": { "title": "UpdateFinancialYearResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FinancialYear->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FinancialYear->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYear->Notes" } ] } } }, "DeleteFinancialYearResourceActionRequest": { "title": "DeleteFinancialYearResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetFinancialYearResourceAction": { "title": "BatchGetFinancialYearResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Financial Year entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Financial Year entities", "items": { "$ref": "#/definitions/GetFinancialYearResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateFinancialYearResourceActionRequest": { "title": "BatchCreateFinancialYearResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFinancialYearResourceActionRequest" } }, "BatchUpdateFinancialYearResourceActionRequest": { "title": "BatchUpdateFinancialYearResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFinancialYearResourceActionRequest" } }, "BatchDeleteFinancialYearResourceActionRequest": { "title": "BatchDeleteFinancialYearResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFinancialYearResourceActionRequest" } }, "ChangeFinancialYearPermissionTreeResourceActionRequest": { "title": "ChangeFinancialYearPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FinancialYear->PermissionTree_Id" } ] } } }, "BatchChangeFinancialYearPermissionTreeResourceActionRequest": { "title": "BatchChangeFinancialYearPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFinancialYearPermissionTreeResourceActionRequest" } }, "GetFinancialYearPeriodResourceActionResponse": { "title": "GetFinancialYearPeriodResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetFinancialYearPeriodResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYearPeriod->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYearPeriod->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "endDate": { "title": "endDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->EndDate" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" }, "isOpen": { "title": "isOpen", "type": "boolean", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->IsOpen" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->Notes" }, "startDate": { "title": "startDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->StartDate" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFinancialYearPeriodForFinancialYearCollectionResourceActionResponse": { "title": "GetFinancialYearPeriodForFinancialYearCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFinancialYearPeriodForFinancialYearCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFinancialYearPeriodForFinancialYearCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "startDate": { "title": "startDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->StartDate" }, "endDate": { "title": "endDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->EndDate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->Notes" }, "isOpen": { "title": "isOpen", "type": "boolean", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->IsOpen" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYearPeriod->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYearPeriod->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetFinancialYearPeriodCollectionResourceActionResponse": { "title": "GetFinancialYearPeriodCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFinancialYearPeriodCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFinancialYearPeriodCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "startDate": { "title": "startDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->StartDate" }, "endDate": { "title": "endDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->EndDate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->Notes" }, "isOpen": { "title": "isOpen", "type": "boolean", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->IsOpen" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYearPeriod->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FinancialYearPeriod->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "UpdateFinancialYearPeriodResourceActionRequest": { "title": "UpdateFinancialYearPeriodResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, { "title": "startDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->StartDate" }, { "title": "endDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "FinancialYearPeriod->EndDate" }, { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->Notes" } ] } } }, "BatchGetFinancialYearPeriodResourceAction": { "title": "BatchGetFinancialYearPeriodResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Financial Year Period entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Financial Year Period entities", "items": { "$ref": "#/definitions/GetFinancialYearPeriodResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchUpdateFinancialYearPeriodResourceActionRequest": { "title": "BatchUpdateFinancialYearPeriodResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFinancialYearPeriodResourceActionRequest" } }, "GetGeneralLedgerResourceActionResponse": { "title": "GetGeneralLedgerResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetGeneralLedgerResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedger->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedger->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "GeneralLedger->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedger->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedger->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedger->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedger->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetGeneralLedgerCollectionResourceActionResponse": { "title": "GetGeneralLedgerCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetGeneralLedgerCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetGeneralLedgerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedger->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedger->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedger->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerChangePermissionTreeLookupResourceActionResponse": { "title": "GeneralLedgerChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerInsertPermissionTreeLookupResourceActionResponse": { "title": "GeneralLedgerInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateGeneralLedgerResourceActionRequest": { "title": "CreateGeneralLedgerResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateGeneralLedgerResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedger->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedger->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateGeneralLedgerResourceActionRequest": { "title": "UpdateGeneralLedgerResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedger->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedger->Notes" } ] } } }, "DeleteGeneralLedgerResourceActionRequest": { "title": "DeleteGeneralLedgerResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetGeneralLedgerResourceAction": { "title": "BatchGetGeneralLedgerResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of General Ledger entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of General Ledger entities", "items": { "$ref": "#/definitions/GetGeneralLedgerResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateGeneralLedgerResourceActionRequest": { "title": "BatchCreateGeneralLedgerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateGeneralLedgerResourceActionRequest" } }, "BatchUpdateGeneralLedgerResourceActionRequest": { "title": "BatchUpdateGeneralLedgerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateGeneralLedgerResourceActionRequest" } }, "BatchDeleteGeneralLedgerResourceActionRequest": { "title": "BatchDeleteGeneralLedgerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteGeneralLedgerResourceActionRequest" } }, "ChangeGeneralLedgerIsActiveResourceActionRequest": { "title": "ChangeGeneralLedgerIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "GeneralLedger->IsActive" } ] } } }, "ChangeGeneralLedgerPermissionTreeResourceActionRequest": { "title": "ChangeGeneralLedgerPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedger->PermissionTree_Id" } ] } } }, "BatchChangeGeneralLedgerIsActiveResourceActionRequest": { "title": "BatchChangeGeneralLedgerIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeGeneralLedgerIsActiveResourceActionRequest" } }, "BatchChangeGeneralLedgerPermissionTreeResourceActionRequest": { "title": "BatchChangeGeneralLedgerPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeGeneralLedgerPermissionTreeResourceActionRequest" } }, "GetGeneralLedgerAttributeResourceActionResponse": { "title": "GetGeneralLedgerAttributeResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetGeneralLedgerAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->GeneralLedger_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetGeneralLedgerAttributeCollectionForGeneralLedgerResourceActionResponse": { "title": "GetGeneralLedgerAttributeCollectionForGeneralLedgerResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetGeneralLedgerAttributeCollectionForGeneralLedgerResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetGeneralLedgerAttributeCollectionForGeneralLedgerResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetGeneralLedgerAttributeCollectionResourceActionResponse": { "title": "GetGeneralLedgerAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetGeneralLedgerAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetGeneralLedgerAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->SequenceNumber" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->GeneralLedger_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "GeneralLedgerAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerAttributeAttributeLookupResourceActionResponse": { "title": "GeneralLedgerAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerAttributeGeneralLedgerLookupResourceActionResponse": { "title": "GeneralLedgerAttributeGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerAttributeGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerAttributeGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "GeneralLedgerAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateGeneralLedgerAttributeResourceActionRequest": { "title": "CreateGeneralLedgerAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateGeneralLedgerAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "generalLedgerId", "attributeId" ], "properties": { "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->GeneralLedger_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "GeneralLedgerAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateGeneralLedgerAttributeResourceActionRequest": { "title": "UpdateGeneralLedgerAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerAttribute->Notes" } ] } } }, "DeleteGeneralLedgerAttributeResourceActionRequest": { "title": "DeleteGeneralLedgerAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetGeneralLedgerAttributeResourceAction": { "title": "BatchGetGeneralLedgerAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of General Ledger Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of General Ledger Attribute entities", "items": { "$ref": "#/definitions/GetGeneralLedgerAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateGeneralLedgerAttributeResourceActionRequest": { "title": "BatchCreateGeneralLedgerAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateGeneralLedgerAttributeResourceActionRequest" } }, "BatchUpdateGeneralLedgerAttributeResourceActionRequest": { "title": "BatchUpdateGeneralLedgerAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateGeneralLedgerAttributeResourceActionRequest" } }, "BatchDeleteGeneralLedgerAttributeResourceActionRequest": { "title": "BatchDeleteGeneralLedgerAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteGeneralLedgerAttributeResourceActionRequest" } }, "ChangeGeneralLedgerAttributeIsActiveResourceActionRequest": { "title": "ChangeGeneralLedgerAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "GeneralLedgerAttribute->IsActive" } ] } } }, "BatchChangeGeneralLedgerAttributeIsActiveResourceActionRequest": { "title": "BatchChangeGeneralLedgerAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeGeneralLedgerAttributeIsActiveResourceActionRequest" } }, "GetGeneralLedgerDocumentResourceActionResponse": { "title": "GetGeneralLedgerDocumentResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetGeneralLedgerDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->GeneralLedger_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GeneralLedgerDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetGeneralLedgerDocumentCollectionForGeneralLedgerResourceActionResponse": { "title": "GetGeneralLedgerDocumentCollectionForGeneralLedgerResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetGeneralLedgerDocumentCollectionForGeneralLedgerResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetGeneralLedgerDocumentCollectionForGeneralLedgerResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetGeneralLedgerDocumentCollectionResourceActionResponse": { "title": "GetGeneralLedgerDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetGeneralLedgerDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetGeneralLedgerDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->GeneralLedger_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "GeneralLedgerDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerDocumentDocumentLookupResourceActionResponse": { "title": "GeneralLedgerDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerDocumentGeneralLedgerLookupResourceActionResponse": { "title": "GeneralLedgerDocumentGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerDocumentGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerDocumentGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GeneralLedgerDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "GeneralLedgerDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GeneralLedgerDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GeneralLedgerDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateGeneralLedgerDocumentResourceActionRequest": { "title": "CreateGeneralLedgerDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateGeneralLedgerDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "generalLedgerId", "documentRecordId" ], "properties": { "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->GeneralLedger_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateGeneralLedgerDocumentResourceActionRequest": { "title": "UpdateGeneralLedgerDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "GeneralLedgerDocument->Notes" } ] } } }, "DeleteGeneralLedgerDocumentResourceActionRequest": { "title": "DeleteGeneralLedgerDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetGeneralLedgerDocumentResourceAction": { "title": "BatchGetGeneralLedgerDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of General Ledger Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of General Ledger Document entities", "items": { "$ref": "#/definitions/GetGeneralLedgerDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateGeneralLedgerDocumentResourceActionRequest": { "title": "BatchCreateGeneralLedgerDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateGeneralLedgerDocumentResourceActionRequest" } }, "BatchUpdateGeneralLedgerDocumentResourceActionRequest": { "title": "BatchUpdateGeneralLedgerDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateGeneralLedgerDocumentResourceActionRequest" } }, "BatchDeleteGeneralLedgerDocumentResourceActionRequest": { "title": "BatchDeleteGeneralLedgerDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteGeneralLedgerDocumentResourceActionRequest" } }, "ChangeGeneralLedgerDocumentIsActiveResourceActionRequest": { "title": "ChangeGeneralLedgerDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->IsActive" } ] } } }, "ChangeGeneralLedgerDocumentPermissionTreeResourceActionRequest": { "title": "ChangeGeneralLedgerDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "GeneralLedgerDocument->PermissionTree_Id" } ] } } }, "BatchChangeGeneralLedgerDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeGeneralLedgerDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeGeneralLedgerDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeGeneralLedgerDocumentIsActiveResourceActionRequest": { "title": "BatchChangeGeneralLedgerDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeGeneralLedgerDocumentIsActiveResourceActionRequest" } } }, "parameters": { "ExecutionMode": { "type": "string", "name": "mode", "in": "query", "description": "Execution mode to use for executing the batch operation", "enum": [ "AllOrNone", "PerRecord" ] }, "Async": { "type": "boolean", "name": "async", "in": "query", "description": "Enqueue the operation asynchronously using a Background Task." }, "AsyncDescription": { "type": "string", "name": "description", "in": "query", "description": "Optional description for the asynchronous execution of the Background Task." }, "Schedule": { "type": "string", "name": "schedule", "in": "query", "description": "Optional cron expression to schedule the asynchronous execution of the Background Task." }, "ScheduleFrom": { "type": "string", "name": "from", "in": "query", "description": "Optional future date at which a recurring schedule for the asynchronous execution of the Background Task should start. If no value is provided the current UTC date and time is used." }, "Filter": { "type": "string", "name": "$filter", "in": "query", "description": "Filter expression to apply on the resource to limit the response data returned, e.g. $filter=id gt 0 and code startswith 'ABCD'" }, "OrderBy": { "type": "string", "name": "$orderby", "in": "query", "description": "Comma separated list of the data properties on the resource to order the response data returned, e.g. $orderby=id DESC,code ASC" }, "Param": { "type": "string", "name": "$param", "in": "query", "description": "Comma separated list of key/value pairs to parameterise `$filter` expressions to limit the response data returned, e.g. $param=@code:'JUMA'" }, "Select": { "type": "string", "name": "$select", "in": "query", "description": "Comma separated list of the data properties on the resource to return, e.g. $select=id,code,description" }, "Skip": { "type": "string", "name": "$skip", "in": "query", "description": "Number of items to skip. Use in combination with `$top` to page through the response data returned, e.g. $skip=20" }, "Top": { "type": "string", "name": "$top", "in": "query", "description": "Number of items to return in the response data, e.g. $top=20" } }, "responses": { "default": { "x-nullable": true, "description": "Error response - operation failed" }, "created": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "accepted": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "scheduled": { "description": "Request was successfully scheduled for asynchronous execution using a Scheduled Background Task", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the Scheduled Background Task resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the Scheduled Background Task resource" }, "OnKey-Job-Id": { "type": "string", "description": "Job id of the job schedule created", "format": "Uuid" }, "OnKey-Job-Schedule-Location": { "type": "string", "description": "URI to fetch the job schedule for the asynchronous execution of the request" } } } }, "securityDefinitions": { "Bearer": { "type": "basic", "description": "Use the JWT access token received by authenticating with your configured On Key Identity Provider" } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "Budget" }, { "name": "Budget Parameter" }, { "name": "Budget Template" }, { "name": "Budget Template Parameter" }, { "name": "Cost Centre" }, { "name": "Cost Centre Attribute" }, { "name": "Cost Centre Document" }, { "name": "Cost Centre Type" }, { "name": "Cost Element" }, { "name": "Cost Element Attribute" }, { "name": "Cost Element Document" }, { "name": "Costing" }, { "name": "Costing Budget" }, { "name": "Currency" }, { "name": "Currency Rate" }, { "name": "Financial Year" }, { "name": "Financial Year Period" }, { "name": "General Ledger" }, { "name": "General Ledger Attribute" }, { "name": "General Ledger Document" } ], "x-tagGroups": [ { "name": "FIN", "tags": [ "Budget", "Budget Parameter", "Budget Template", "Budget Template Parameter", "Cost Centre", "Cost Centre Attribute", "Cost Centre Document", "Cost Centre Type", "Cost Element", "Cost Element Attribute", "Cost Element Document", "Costing", "Costing Budget", "Currency", "Currency Rate", "Financial Year", "Financial Year Period", "General Ledger", "General Ledger Attribute", "General Ledger Document" ] } ] }